Sign in

v51

latestOpenAPI 3.0.1MITraw.githubusercontent.com2026-08-01150230854.3 KB
Subscription Types
Contacts

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.

post/contacts/{contact_id}/subscriptions

Path parameters

contact_idstring required

The unique identifier for the contact which is given by Intercom

Headers

Intercom-Version'1.0' | '1.1' | '1.2' | '1.3' | '1.4' | '2.0' | '2.1' | '2.2' | '2.3' | '2.4' | '2.5' | '2.6' | '2.7' | '2.8' | '2.9' | '2.10' | '2.11' | '2.12' | '2.13' | '2.14'

Intercom API version.</br>By default, it's equal to the version set in the app package.

Example:2.14

Request body

idstring required

The unique identifier for the subscription which is given by Intercom

consent_typestring required

The consent_type of a subscription, opt_out or opt_in.

Example request

{
  "id": "37846",
  "consent_type": "opt_in"
}

Response

Successful

typestring

The type of the object - subscription

idstring

The unique identifier representing the subscription type.

state'live' | 'draft' | 'archived'

The state of the subscription type.

consent_type'opt_out' | 'opt_in'

Describes the type of consent.

content_typesstring[]

The message types that this subscription supports - can contain email or sms_message.

Example response

{
  "type": "subscription",
  "id": "123456",
  "state": "live",
  "default_translation": {
    "name": "Announcements",
    "description": "Offers, product and feature announcements",
    "locale": "en"
  },
  "translations": [
    {
      "name": "Announcements",
      "description": "Offers, product and feature announcements",
      "locale": "en"
    }
  ],
  "consent_type": "opt_in",
  "content_types": [
    "email"
  ]
}