This topic describes the entity and type representations for common items that the Communication Preference API uses. To learn about how to set up your developer account and work with the SKY API, see the Getting Started guide.
Represents the consent category entity.
The ConsentCategory entity has the following properties:
| Property | Required | Type | Description | Description |
|---|---|---|---|---|
| description | Property is required | string string | The name of the consent category. | |
| inactive | Property is required | boolean boolean | Indicates whether the consent category is inactive. | |
| sequence | Property is required | integer integer | The placement of the category in the order of category table values, if defined. |
A collection of consent categories.
The ConsentCategoryCollection entity has the following properties:
| Property | Required | Type | Description | Description |
|---|---|---|---|---|
| count | Property is required | integer integer | The number of consent categories in the list. | |
| value | Property is required | array of consentcategory array of consentcategory | Represents the consent category entity. |
Represents the consent channel entity.
The ConsentChannel entity has the following properties:
| Property | Required | Type | Description | Description |
|---|---|---|---|---|
| description | Property is required | string string | The name of the consent channel. |
Represents a valid consent channel category combination.
The ConsentChannelCategory entity has the following properties:
| Property | Required | Type | Description | Description |
|---|---|---|---|---|
| channel | Property is required | string string | The name of the channel included in the channel/category combination. | |
| category | Property is required | string string | The name of the category included in the channel/category combination. | |
| sequence | Property is required | integer integer | The placement of the channel/category in the order of channel/category table values, if defined. |
A collection of consent channel categories.
The ConsentChannelCategoryCollection entity has the following properties:
| Property | Required | Type | Description | Description |
|---|---|---|---|---|
| count | Property is required | integer integer | The number of consent channel categories in the list. | |
| value | Property is required | array of consentchannelcategory array of consentchannelcategory | Represents a valid consent channel category combination. |
A collection of consent channels.
The ConsentChannelCollection entity has the following properties:
| Property | Required | Type | Description | Description |
|---|---|---|---|---|
| count | Property is required | integer integer | The number of consent channels in the list. | |
| value | Property is required | array of consentchannel array of consentchannel | Represents the consent channel entity. |
Represents the consent source entity.
The ConsentSource entity has the following properties:
| Property | Required | Type | Description | Description |
|---|---|---|---|---|
| description | Property is required | string string | The name of the consent source. | |
| inactive | Property is required | boolean boolean | Indicates whether the consent source is inactive. | |
| sequence | Property is required | integer integer | The placement of the source in the order of source table values, if defined. |
A collection of consent sources.
The ConsentSourceCollection entity has the following properties:
| Property | Required | Type | Description | Description |
|---|---|---|---|---|
| count | Property is required | integer integer | The number of consent sources in the list. | |
| value | Property is required | array of consentsource array of consentsource | Represents the consent source entity. |
Represents the consent entity to add to the specified constituent.
The ConstituentConsentAdd entity has the following properties:
| Property | Required | Type | Description | Description |
|---|---|---|---|---|
| constituent_id | Property is required | string string | The immutable system record ID of the constituent associated with the consent record. | |
| channel | Property is required | string string | The channel that the consent response applies to. Available values can be obtained from the Consent Channels List. | |
| category | Property is required | string string | The category that the consent response applies to. Available values can be obtained from the Consent Categories List. | |
| source | Property is required | string string | The source of the consent response from the constituent. Available values can be obtained from the Consent Sources List. | |
| consent_date | Property is required | datetime datetime | The date the consent response was received. | |
| constituent_consent_response | Property is required | string string | How the constituent responded to consent for the specified channel/category. Available values are OptIn, OptOut, and NoResponse.
| |
| privacy_notice | Property is required | string string | The privacy notice provided to the constituent. | |
| consent_statement | Property is required | string string | The statement the constituent responded to when providing consent. | |
| user_name | Property is required | string string | The user name associated with the consent. If not supplied, will have a default set based on the user's account. |
Represents a consent entity for a constituent.
The ConstituentConsentRead entity has the following properties:
| Property | Required | Type | Description | Description |
|---|---|---|---|---|
| id | Property is required | string string | The immutable system record ID of the consent record. | |
| channel | Property is required | string string | The channel that the consent response applies to. Available values can be obtained from the Consent Channels List. | |
| category | Property is required | string string | The category that the consent response applies to. Available values can be obtained from the Consent Categories List. | |
| source | Property is required | string string | The source of the consent response from the constituent. Available values can be obtained from the Consent Sources List. | |
| consent_date | Property is required | datetime datetime | The date the consent response was received. | |
| constituent_consent_response | Property is required | string string | How the constituent responded to consent for the specified channel/category. Available values are OptIn, OptOut, and NoResponse.
| |
| privacy_notice | Property is required | string string | The privacy notice provided to the constituent. | |
| consent_statement | Property is required | string string | The statement the constituent responded to when providing consent. | |
| date_added | Property is required | datetime datetime | The date the consent response was added. | |
| user_name | Property is required | string string | The user that added the consent response. |
A collection of consent records.
The ConstituentConsentReadCollection entity has the following properties:
| Property | Required | Type | Description | Description |
|---|---|---|---|---|
| count | Property is required | integer integer | The number of consent records in the list. | |
| value | Property is required | array of constituentconsentread array of constituentconsentread | Represents a consent entity for a constituent. |
Solicit codes provide guidance on how to contact constituents. These rules describe instructions and restrictions about when to reach out to constituents and how to tailor communications to honor their requests.
The ConstituentSolicitCodeAdd entity has the following properties:
| Property | Required | Type | Description | Description |
|---|---|---|---|---|
| constituent_id | Property is required | string string | The immutable system record ID of the constituent associated with the solicit code. | |
| end_date | Property is required | datetime datetime | The end date of the solicit code. Uses ISO-8601 format: 1969-11-21T10:29:43. | |
| solicit_code | Property is required | string string | Communication instructions and/or restrictions for a constituent. Available values can be obtained from the Solicit Codes List. | |
| start_date | Property is required | datetime datetime | The start date of the solicit code. Uses ISO-8601 format: 1969-11-21T10:29:43. |
Solicit codes provide guidance on how to contact constituents. These rules describe instructions and restrictions about when to reach out to constituents and how to tailor communications to honor their requests.
The ConstituentSolicitCodeRead entity has the following properties:
| Property | Required | Type | Description | Description |
|---|---|---|---|---|
| id | Property is required | string string | The immutable system record ID of the constituent solicit code. | |
| constituent_id | Property is required | string string | The immutable system record ID of the constituent associated with the solicit code. | |
| end_date | Property is required | datetime datetime | The end date of the solicit code. Uses ISO-8601 format: 1969-11-21T10:29:43. | |
| solicit_code | Property is required | string string | Communication instructions and/or restrictions for a constituent. Available values can be obtained from the Solicit Codes List. | |
| start_date | Property is required | datetime datetime | The start date of the solicit code. Uses ISO-8601 format: 1969-11-21T10:29:43. |
A collection of constituent solicit codes.
The ConstituentSolicitCodeReadCollection entity has the following properties:
| Property | Required | Type | Description | Description |
|---|---|---|---|---|
| count | Property is required | integer integer | The number of constituent solicit codes in the list. | |
| value | Property is required | array of constituentsolicitcoderead array of constituentsolicitcoderead | Solicit codes provide guidance on how to contact constituents. These rules describe instructions and restrictions about when to reach out to constituents and how to tailor communications to honor their requests. |
Response for creating a record.
The PostResponse entity has the following properties:
| Property | Required | Type | Description | Description |
|---|---|---|---|---|
| id | Property is required | string string | Id of the created record. |
Base service error contract.
The ServiceError entity has the following properties:
| Property | Required | Type | Description | Description |
|---|---|---|---|---|
| message | Property is required | string string | The message of the service error with any string arguments replaced. | |
| error_name | Property is required | string string | The name of the service error. | |
| error_code | Property is required | integer integer | Code number of the service error. | |
| raw_message | Property is required | string string | The raw message of the service error. This message may contain string replacement arguments (ie: {0}, {1}, etc) that map to the 'error_args' property and will be replaced when you get the full message from the 'message' property. | |
| error_args | Property is required | array of string array of string | A list of arguments to be replaced in the raw message. Useful for when the message needs to be localized. |
Represents the solicit code entity.
The SolicitCode entity has the following properties:
| Property | Required | Type | Description | Description |
|---|---|---|---|---|
| description | Property is required | string string | The name of the solicit code. |
A collection of solicit codes.
The SolicitCodeCollection entity has the following properties:
| Property | Required | Type | Description | Description |
|---|---|---|---|---|
| count | Property is required | integer integer | The number of solicit codes in the list. | |
| value | Property is required | array of solicitcode array of solicitcode | Represents the solicit code entity. |