provider Subscription TypesContacts POST /contacts/{contact_id}/subscriptions
@utdk/intercom /contacts/{contact_id}/subscriptions
Add subscription to a contact
You can add a specific subscription to a contact. In Intercom, we have two different subscription types based on user consent - opt-out and opt-in: 1.Attaching a contact to an opt-out subscription type will opt that user out from receiving messages related to that subscription type. 2.Attaching a contact to an opt-in subscription type will opt that user in to receiving messages related to that subscription type. This will return a subscription type model for the subscription type that was added to the contact.
Intercom-Version header
enum: 1.0, 1.1, 1.2, 1.3…
contact_id path required
The unique identifier for the contact which is given by Intercom
string

Try it

Authentication
Configure credentials for Intercom API
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

attachsubscriptiontypetocontact
POST/contacts/{contact_id}/subscriptions
You can add a specific subscription to a contact. In Intercom, we have two different subscription types based on user consent - opt-out and opt-in: 1.Attaching a contact to an opt-out subscription type will opt that user out from receiving messages related to that subscription type. 2.Attaching a contact to an opt-in subscription type will opt that user in to receiving messages related to that subscription type. This will return a subscription type model for the subscription type that was added to the contact.

Parameters

required

The unique identifier for the contact which is given by Intercom

Input

required

The unique identifier for the subscription which is given by Intercom

required

The consent_type of a subscription, opt_out or opt_in.

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import intercom from '@utdk/intercom';

await intercom.attachsubscriptiontypetocontact({
  "Intercom-Version": "2.14"
})