DocsBuilding AppsInstalling IntercomAPI & Webhook ReferenceCanvas Kit Reference
DocsApp StoreForumBlogYour Apps

List attached email and SMS subscriptions

Example Request & Response

$ curl https://api.intercom.io/contacts/<id>/subscriptions \
-H 'Authorization:Bearer <Your access token>' \
-H 'Accept:application/json'
HTTP/1.1 200 OK
{
  "type": "list",
  "data": [
    {
      "type": "subscription",
      "id": "1",
      "state": "live",
      "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"
        }
      ]
      "consent_type": "opt_out"
    }
  ]
}
Example Errors

HTTP/1.1 404 NOT FOUND
{
    "type": "error.list",
    "request_id": "cc1a749e-6cc4-4b7c-944c-e26bb6d61662",
    "errors": [
        {
            "code": "not_found",
            "message": "User Not Found"
        }
    ]
}

You can fetch a list of subscription types that are attached to a contact. These can be subscriptions that a user has 'opted-in' to or has 'opted-out' from, depending on the subscription type.

Request Path Parameter

Parameter

Type

Required

Description

id

String

Yes

The unique identifier for the contact which is given by Intercom

Response

This will return a list of Subscription Type objects that the contact is associated with.

The data property will show a combined list of

  • Opt-out subscription types that the user has opted-out from
  • Opt-in subscription types that the user has opted-in to receiving

Attribute

Type

Description

type

String

The type of object - list

data

Array

A list of subscriptions tied to the contact