Intercom API (unofficial showcase)
POST/contacts/{contact_id}/subscriptions

Add a subscription to a contact

Adds a subscription type to a contact and applies its opt-in or opt-out preference. Supply the subscription id and consent_type to specify which subscription to attach and how the contact has consented.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

2 parameters · 2 body fields
contact_idstringrequired
The unique identifier of the contact to add the subscription to.
Intercom-Versionstringoptional
The Intercom API version to use; the listed values include 1.0 through 2.6. Defaults to 2.17 when omitted.
Allowed:1.01.11.21.31.42.02.12.22.32.42.52.6Default:2.17

Subscription details specifying the subscription type and the contact's consent preference.

idstringrequired
The unique identifier for the subscription which is given by Intercom
consent_typestringrequired
The consent_type of a subscription, opt_out or opt_in.

3 status codes
200Returns the subscription type object added to the contact, including its state, consent type, translations, and supported content types.
typestringoptional
The type of the object - subscription
idstringoptional
The unique identifier representing the subscription type.
statestringoptional
The state of the subscription type.
Allowed:livedraftarchived
default_translationobjectoptional
A translation object contains the localised details of a subscription type.
translationsarray<Translation>optional
An array of translations objects with the localised version of the subscription type in each available locale within your translation settings.
consent_typestringoptional
Describes the type of consent.
Allowed:opt_outopt_in
content_typesarray<string>optional
The message types that this subscription supports - can contain `email` or `sms_message`.
401Returned when the request is unauthorized.

One documented failure

  • unauthorized

    Access Token Invalid

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects
404Returned when the requested resource is not found.

One documented failure

  • not_found

    User Not Found

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects

Error handling

A 401 is returned when the request is unauthorized. A 404 is returned when the contact or subscription resource is not found. The contact_id path parameter identifies the contact; the request body must include id and consent_type, which must be opt_out or opt_in. The Intercom-Version header defaults to 2.17 when omitted.