List attached email and SMS subscriptions
Example Request & Response
$ curl https://api.intercom.io/contacts/<id>/subscriptions \\\n-H 'Authorization:Bearer <Your access token>' \\\n-H 'Accept:application/json'
Example Errors
Contact not found
HTTP/1.1 404 NOT FOUND\n{\n \"type\": \"error.list\",\n \"request_id\": \"cc1a749e-6cc4-4b7c-944c-e26bb6d61662\",\n \"errors\": [\n {\n \"code\": \"not_found\",\n \"message\": \"User Not Found\"\n }\n ]\n}
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 |