Subscription Types

REST API Reference

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

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. Enum: "live" "draft" "archived"
	object (Translation) A translation object contains the localised details of a subscription type.
	Array 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_type	string Describes the type of consent. Enum: "opt_out" "opt_in"
content_types	Array of strings The message types that this subscription supports - can contain `email` or `sms_message`. Items Enum: "email" "sms_message"

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