API ReferenceBuilding AppsInstalling IntercomAPI & Webhook ReferenceCanvas Kit Reference
DocsApp StoreForumBlogYour Apps

The Subscription type model

Example Subscription type Object

{
  "type": "subscription",
  "id": "1",
  "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.

Subscription type Object

KeyTypeDescription
typeStringThe type of the object - subscription
idStringThe unique identifier representing the subscription type.
stateStringThe state of the subscription type: live, draft, archived.
default_translationObjectA translation object with the localised version of the subscription type in the default language for the workspace.
translationsArrayAn array of translations objects with the localised version of the subscription type in each available locale within your translation settings.
consent_typeStringDescribes the type of consent, this could be either 'opt_out' or 'opt_in'.
content_typesArrayThe message types that this subscription supports - can contain 'email' or 'sms_message'.