POST {clientId}/Config/TextTags

Add Text Tags. Note: This call should only be used for promoting new Text Tags.If a text tag already exists, this API will remove any existing locales and associate the locales that you specify in your request. This will remove any values associated with the text tag for those locales across Program Groups, Programs, Filters and Frequencies.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
clientId

Your required clientId used to access the WebAPI. A 404 is returned if this value is invalid.

 string

Required

Body Parameters

Collection of TextTags to submit

Collection of ConfigTextTag
NameDescriptionTypeAdditional information
OverwriteExisting

boolean

None.
Key

string

Required

Min length: 1
Locales

Collection of ConfigLocaleIDOnly

Required

Request Formats

application/json, text/json

Sample: 
[
  {
    "OverwriteExisting": true,
    "Key": "sample string 2",
    "Locales": [
      {
        "ID": "sample string 1"
      }
    ]
  }
]

application/xml, text/xml

Sample: 
<ArrayOfConfigTextTag xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyPreferences.REST.ConfigModels">
  <ConfigTextTag>
    <Key>sample string 2</Key>
    <Locales>
      <ConfigLocaleIDOnly>
        <ID>sample string 1</ID>
      </ConfigLocaleIDOnly>
    </Locales>
    <OverwriteExisting>true</OverwriteExisting>
  </ConfigTextTag>
</ArrayOfConfigTextTag>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Response Codes

  • Unauthorized (401)
  • InternalServerError (500)
  • BadRequest (400)

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.