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

The Subscription Type model

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

FieldTypeDescription
typestringThe type of the object - subscription
idstringThe unique identifier representing the subscription type.
statestringThe state of the subscription type.
default_translationobjectA translation object contains the localised details of a subscription type.
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.
content_typesarrayThe message types that this subscription supports - can contain email or sms_message.

Translation

FieldTypeDescription
namestringThe localised name of the subscription type.
descriptionstringThe localised description of the subscription type.
localestringThe two character identifier for the language of the translation object.