POST {clientId}/Config/CustomProperties/Program

Add Custom Properties on Programs. This API will add Custom Properties that don’t exist on your account before associating them to the Program.

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 Program Custom Properties to submit

Collection of ConfigProgramCustomProperty
NameDescriptionTypeAdditional information
ID

string

Required

Min length: 1
CustomProperties

Collection of ConfigCustomProperty

Required

Request Formats

application/json, text/json

Sample: 
[
  {
    "ID": "sample string 1",
    "CustomProperties": [
      {
        "Link": 1,
        "OverwriteExisting": true,
        "Key": "sample string 3",
        "Value": "sample string 4"
      }
    ]
  }
]

application/xml, text/xml

Sample: 
<ArrayOfConfigProgramCustomProperty xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyPreferences.REST.ConfigModels">
  <ConfigProgramCustomProperty>
    <CustomProperties>
      <ConfigCustomProperty>
        <Key>sample string 3</Key>
        <Value>sample string 4</Value>
        <Link>1</Link>
        <OverwriteExisting>true</OverwriteExisting>
      </ConfigCustomProperty>
    </CustomProperties>
    <ID>sample string 1</ID>
  </ConfigProgramCustomProperty>
</ArrayOfConfigProgramCustomProperty>

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.