| Name | Description | Type | Additional information |
|---|---|---|---|
| ProgramId |
The unique identifier of a Program |
string |
Read-Only |
| ChannelId |
The unique identifier of the Channel. Phone, Fax, Text, Email and Mail are the channel ID values. |
string |
Read-Only |
| Consents |
|
Collection of ConsentFilterVersion |
Read-Only |
| MatchType |
The Match Type indicates if the preference was Expressed or Implied. This only applies if your account has the Preference Propagation feature enabled. |
string |
Read-Only |
| ReasonCode |
Represents the reason for deactivation as specified on a preference deactivation request. |
string |
Read-Only |
| ExpirationDate |
The computed date when the preference will expire based on the preference expiration duration configured on the Filter.If there is no expiration setup, the system will output a blank value. |
string |
Read-Only |
| PreferenceStatus |
The status of the preference, Active or Expired. |
string |
Read-Only |
| LastModifiedDate |
The date and time when the preference was last updated in the system. This is a system generated date. |
string |
Read-Only |
| UserId |
The ID of the user or system that recorded the preference |
string |
Read-Only |
| SourceId |
The ID of the Source Group associated with the user that recorded the preference. |
string |
Read-Only |
| FilterId |
The unique identifier of a Filter (preference option). |
string |
Required Max length: 50 Min length: 1 |
| PreferenceType |
Contains the preference type number to determine if it is an Opt-In (1) or Opt-Out (2). |
PreferenceTypes |
Required |
| FrequencyId |
The communication frequency associated with the preference. For preferences with no frequency value, the system will output the default frequency value associated with the Filter. |
string |
Max length: 20 This field is optional. If frequency is not provided, the default frequency value configured for the Filter is applied. |
| PreferenceAttributes |
A collection of additional data elements that you want to store with the preference |
Collection of PreferenceAttribute |
Attributes are key-value pairs of data that you can associate with a preference. For example, a Marketing campaign ID through which the preference was captured or start and end times for a balance alert or a weather advisory notification. This API allows you to capture and submit attribute data without prior configuration in MyPreferences. |
| CustomerDate |
DateTime when the preference was collected. |
string |
This field is optional and defaults to current date and time in Coordinated Universal Time (UTC) if not specified. If you specify it in UTC format, it will be stored as such. If not, it will be treated as Eastern and converted to UTC before getting saved. If only the date value is passed, the following logic is applied based on the preference type (Opt - In or Opt - Out) associated with the preference: For Opt - In preferences, the time will be set to midnight in Eastern Time and stored as UTC. For example, passing 2021 - 01 - 06 will be stored as 2021 - 01 - 06T05: 00:00Z For Opt - Out preferences, the time will be set to 11:59:59 PM in Eastern Time and stored as UTC. For example, passing 2021 - 01 - 06 will be stored as 2021 - 01 - 07T04: 59:59Z Note: When Daylight Savings Time(DST) is in effect, MyPreferences automatically adjusts when setting the time value in Eastern Time. |