PUT api/v1/admin/placeholders/{id}

Updates a placeholder onto the account.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The ID of the placeholder.

integer

Required

Body Parameters

The new description of the placeholder.

PlaceHolderRequest
NameDescriptionTypeAdditional information
Description

Describes what this placeholder is to be used for.

string

Required

Request Formats

application/json, text/json

Sample:
{
  "Description": "sample string 1"
}

application/xml, text/xml

Sample:
<PlaceHolderRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Description>sample string 1</Description>
</PlaceHolderRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResponseOfPlaceHolderResponse
NameDescriptionTypeAdditional information
Error

Error

None.

ResponseData

ResponseDataOfPlaceHolderResponse

None.

Response Formats

application/json, text/json

Sample:
{
  "Error": {
    "ErrorCode": "sample string 1",
    "ErrorReason": "sample string 2"
  },
  "ResponseData": {
    "Identification": {
      "UserId": "sample string 1"
    },
    "Result": "sample string 1",
    "Detail": {
      "ID": 1,
      "ReadOnly": true,
      "Description": "sample string 3"
    }
  }
}

application/xml, text/xml

Sample:
<ResponseOfPlaceHolderResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Error>
    <ErrorCode>sample string 1</ErrorCode>
    <ErrorReason>sample string 2</ErrorReason>
  </Error>
  <ResponseData>
    <Result>sample string 1</Result>
    <Identification>
      <UserId>sample string 1</UserId>
    </Identification>
    <Detail>
      <Description>sample string 3</Description>
      <ID>1</ID>
      <ReadOnly>true</ReadOnly>
    </Detail>
  </ResponseData>
</ResponseOfPlaceHolderResponse>