Example Subscription type Object
{
"type": "subscription",
"id": "2",
"state": "live",
"consent_type": "opt_out",
"default_translation": {
"name": "Announcements",
"description": "Offers, product and feature announcements",
"locale": "en"
},
"translations": [
{
"name": "Ankündigungen",
"description": "Angebote, Produkt- und Funktionsankündigungen",
"locale": "de"
},
{
"name": "Announcements",
"description": "Offers, product and feature announcements",
"locale": "en"
}
]
}
A subscription type lets customers easily opt out of non-essential communications without missing what's important to them.
Object Models
Subscription Type
| Field | Type | Description |
|---|---|---|
| type | string | The type of the object - subscription |
| id | string | The unique identifier representing the subscription type. |
| state | string | The state of the subscription type. |
| default_translation | object | A translation object contains the localised details of a subscription type. |
| translations | array | An array of translations objects with the localised version of the subscription type in each available locale within your translation settings. |
| consent_type | string | Describes the type of consent. |
| content_types | array | The message types that this subscription supports - can contain email or sms_message. |
Translation
| Field | Type | Description |
|---|---|---|
| name | string | The localised name of the subscription type. |
| description | string | The localised description of the subscription type. |
| locale | string | The two character identifier for the language of the translation object. |