| Name | Description | Type | Additional information |
|---|---|---|---|
| ProgramID |
Read-Only: This field is only provided when retrieving preference information and has no relevance to adding preferences. |
string |
Max length: 50 Read-Only |
| ChannelID |
Read-Only: This field is only provided when retrieving preference information and has no relevance to adding preferences. |
string |
Max length: 100 Read-Only |
| UserID |
Read-Only: This field is only provided when retrieving preference information and has no relevance to adding preferences. |
string |
Max length: 256 Read-Only |
| SourceID |
Read-Only: This field is only provided when retrieving preference information and has no relevance to adding preferences. |
string |
Max length: 100 Read-Only |
| LastModifiedDate |
Read-Only: This field is only provided when retrieving preference information and has no relevance to adding preferences. |
string |
Read-Only |
| FilterID |
Contains the ID of the filter in which to store the submitted preference. |
string |
Required Max length: 50 |
| CustomProperties |
Read-Only: This collection is only provided when retrieving preference information and has no relevance to adding preferences. |
Collection of Attribute |
Read-Only |
| CID |
Contains the customer id associated with this preference. This value can be empty ("") or null if a contact element is provided. |
string |
Max length: 50 |
| Prefix |
Contains the name prefix associated with this preference. This value can be empty ("") or null if a contact element is provided. |
string |
Max length: 5 |
| FirstName |
Contains the first name associated with this preference. This value can be empty ("") or null if a contact element is provided. |
string |
Max length: 32 |
| MiddleName |
Contains the middle name associated with this preference. This value can be empty ("") or null if a contact element is provided. |
string |
Max length: 32 |
| LastName |
Contains the last name associated with this preference. This value can be empty ("") or null if a contact element is provided. |
string |
Max length: 100 |
| Suffix |
Contains the name suffix associated with this preference. This value can be empty ("") or null if a contact element is provided. |
string |
Max length: 5 |
| PreferenceType |
Contains the preference type number to determine if it is an Opt-In filter (1) or Opt-Out filter (2). |
integer |
Required |
| ContactElement |
Contains the contact element information to submit with this preference. This field can be ommitted or null if a CID is provided. |
ContactElement |
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 |
Max length: 20 |
| 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 |
| MatchType |
Read-Only field: This field is only provided when retrieving preference information and has no relevance to adding preferences. |
string |
Max length: 9 Read-Only |
| ReasonCode |
Write-Only Field: This field is only provided for Deactivate Preference and has no relevance to adding and/or getting preferences. |
string |
Write-Only |
| ExpirationDate |
Read-Only field: This field is only provided when retrieving preference information and has no relevance to adding preferences. |
string |
Read-Only |
| PreferenceStatus |
Read-Only field: This field is only provided when retrieving preference information and has no relevance to adding preferences. |
string |
Max length: 7 Read-Only |