Skip to content
Home/
REST API Reference
/
/
Subscription Types

Subscription Types

A subscription type lets customers easily opt out of non-essential communications without missing what's important to them.

typestring

The type of the object - subscription

Example:"subscription"
idstring

The unique identifier representing the subscription type.

Example:"123456"
statestring

The state of the subscription type.

Enum:"live""draft""archived"
Example:"live"
default_translationobject(Translation)

A translation object contains the localised details of a subscription type.

translationsArray of objects(Translation)

An array of translations objects with the localised version of the subscription type in each available locale within your translation settings.

consent_typestring

Describes the type of consent.

Enum:"opt_out""opt_in"
Example:"opt_in"
content_typesArray of strings

The message types that this subscription supports - can contain email or sms_message.

Items Enum:"email""sms_message"
Example:
[
  "email"
]
{
  "type": "subscription",
  "id": "123456",
  "state": "live",
  "default_translation": {
    "name": "Announcements",
    "description": "Offers, product and feature announcements",
    "locale": "en"
  },
  "translations": [
    { … }
  ],
  "consent_type": "opt_in",
  "content_types": [
    "email"
  ]
}