POST {clientId}/Preferences/ProgramGroup/{programGroupId}

Add preferences across all Filters within Programs for a Program Group. Note: You can specify a Channel ID to restrict the preference updates to a specific channel.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
programGroupId

A valid Program Group Id.

 string

Required
clientId

string

None.

Body Parameters

A preference object to submit.

ProgramGroupPreference
NameDescriptionTypeAdditional information
CID

Contains the customer id associated with this preference. This value can be empty ("") or null if a contact element is provided.

 string

None.
Prefix

Contains the name prefix associated with this preference. This value can be empty ("") or null if a contact element is provided.

 string

None.
FirstName

Contains the first name associated with this preference. This value can be empty ("") or null if a contact element is provided.

 string

None.
MiddleName

Contains the middle name associated with this preference. This value can be empty ("") or null if a contact element is provided.

 string

None.
LastName

Contains the last name associated with this preference. This value can be empty ("") or null if a contact element is provided.

 string

None.
Suffix

Contains the name suffix associated with this preference. This value can be empty ("") or null if a contact element is provided.

 string

None.
GlobalPreferenceType

Contains the preference type number to determine if it is an Opt-In filter (1) or Opt-Out filter (2). Specific preference types in the channels collection will override this value.

 integer

Required
UpdateNestedGroups

Contains the option to determine if this call will update nested program groups (1) or not (0).

 integer

Required
ChannelContactPreference

Contains the contact element information to submit with this preference. This field can be ommitted or null if a CID is provided.

 Collection of ChannelContactElement

None.
FrequencyID

Contains the FrequencyID to submit with the preference. This frequencyId must have been defined for this Filter ID in order for it to be submitted properly.

 string

None.
PreferenceAttributes

Contains the preference attributes associated with this CID or ContactElement for this specific Filter ID.

 Collection of Attribute

None.
CustomerDate

Contains the customer date to associate with this preference. If no date is provided then today's date and time, determined at processing time, will be assigned to this preference. Write-Only field: This field is only evaluated during the submission of preferences.

 string

Write-Only

Request Formats

application/json, text/json

Sample: 
{
  "CID": "sample string 1",
  "Prefix": "sample string 2",
  "FirstName": "sample string 3",
  "MiddleName": "sample string 4",
  "LastName": "sample string 5",
  "Suffix": "sample string 6",
  "GlobalPreferenceType": 7,
  "UpdateNestedGroups": 8,
  "ChannelContactPreference": [
    {
      "ChannelId": "sample string 1",
      "ChannelPreferenceType": 2,
      "Email": "sample string 3",
      "PFT": "sample string 4",
      "Address1": "sample string 5",
      "Address2": "sample string 6",
      "City": "sample string 7",
      "StateProvince": "sample string 8",
      "CountryCode": "sample string 9",
      "PostalCode": "sample string 10"
    }
  ],
  "FrequencyID": "sample string 9",
  "PreferenceAttributes": [
    {
      "Link": 1,
      "Key": "sample string 2",
      "Value": "sample string 3"
    }
  ],
  "CustomerDate": "sample string 10"
}

application/xml, text/xml

Sample: 
<ProgramGroupPreference xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyPreferences.REST.Models">
  <CID>sample string 1</CID>
  <CustomerDate>sample string 10</CustomerDate>
  <FirstName>sample string 3</FirstName>
  <FrequencyID>sample string 9</FrequencyID>
  <GlobalPreferenceType>7</GlobalPreferenceType>
  <LastName>sample string 5</LastName>
  <MiddleName>sample string 4</MiddleName>
  <Prefix>sample string 2</Prefix>
  <Suffix>sample string 6</Suffix>
  <UpdateNestedGroups>8</UpdateNestedGroups>
</ProgramGroupPreference>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Response Codes

  • NotFound (404)
  • BadRequest (400)
  • Unauthorized (401)
  • NoContent (204)

Resource Description

None.