POST {clientId}/Config/ProgramGroups/Update

Add Program Groups. This API will add Text Tags and Custom Properties that don’t exist on your account before associating them to the Program Group.

Request Information

URI Parameters

Name	Description	Type	Additional 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 Groups to submit

Collection of ConfigProgramGroupUpdate

Name	Type	Additional information
ID	string	Required Min length: 1
Name	string	Required Min length: 1
DefaultLocaleID	string	Required Min length: 1
CustomProperties	Collection of ConfigKeyValue	None.
Locales	Collection of ConfigLocaleDisplayTags	None.
Programs	Collection of ConfigProgramGroupPrograms	None.
Description	string	None.

Request Formats

application/json, text/json

Sample:

[
  {
    "Description": "sample string 1",
    "ID": "sample string 1",
    "Name": "sample string 2",
    "DefaultLocaleID": "sample string 3",
    "CustomProperties": [
      {
        "Key": "sample string 1",
        "Value": "sample string 2"
      }
    ],
    "Locales": [
      {
        "DisplayTags": [
          {
            "Key": "sample string 1",
            "Value": "sample string 2"
          }
        ],
        "ID": "sample string 1"
      }
    ],
    "Programs": [
      {
        "Filters": [
          {
            "ProgramGroupDefaultValue": 1,
            "Link": 2,
            "ID": "sample string 3"
          }
        ],
        "ID": "sample string 1"
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfConfigProgramGroupUpdate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyPreferences.REST.ConfigModels">
  <ConfigProgramGroupUpdate>
    <CustomProperties>
      <ConfigKeyValue>
        <Key>sample string 1</Key>
        <Value>sample string 2</Value>
      </ConfigKeyValue>
    </CustomProperties>
    <DefaultLocaleID>sample string 3</DefaultLocaleID>
    <Description>sample string 1</Description>
    <ID>sample string 1</ID>
    <Locales>
      <ConfigLocaleDisplayTags>
        <ID>sample string 1</ID>
        <DisplayTags>
          <ConfigKeyValue>
            <Key>sample string 1</Key>
            <Value>sample string 2</Value>
          </ConfigKeyValue>
        </DisplayTags>
      </ConfigLocaleDisplayTags>
    </Locales>
    <Name>sample string 2</Name>
    <Programs>
      <ConfigProgramGroupPrograms>
        <ID>sample string 1</ID>
        <Filters>
          <ConfigFilterProgramGroupUpdate>
            <ID>sample string 3</ID>
            <Link>2</Link>
            <ProgramGroupDefaultValue>1</ProgramGroupDefaultValue>
          </ConfigFilterProgramGroupUpdate>
        </Filters>
      </ConfigProgramGroupPrograms>
    </Programs>
  </ConfigProgramGroupUpdate>
</ArrayOfConfigProgramGroupUpdate>

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.