DocsBuilding AppsInstalling IntercomAPI & Webhook ReferenceCanvas Kit Reference
DocsApp StoreForumBlogYour Apps

Attach a contact to a subscription type

Example Request & Response

$ curl https://api.intercom.io/contacts/<id>/subscriptions \
-X POST \
-H 'Authorization:Bearer <Your access token>' \
-H 'Accept:application/json' \
-H 'Content-Type: application/json' -d

{
  "id": "1",
  "consent_type": "opt_out"
}
HTTP/1.1 200 OK
{
  "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": "9a3d0816-9707-4598-977e-c009ba630148",
  "errors": [
    {
      "code": "not_found",
      "message": "User Not Found"
    }
  ]
}
HTTP/1.1 404 NOT FOUND
{
  "type": "error.list",
  "request_id": "060932ab-ab9d-4f89-88f3-d0152d005873",
  "errors": [
    {
      "code": "not_found",
      "message": "Resource Not Found"
    }
  ]
}

In Intercom, we have two different subscription types based on user consent - opt-out and opt-in.

Attaching a contact to an opt-out subscription type will opt that user out from receiving messages related to that subscription type.

Attaching a contact to an opt-in subscription type will opt that user in to receiving messages related to that subscription type.

Request Path Parameter

Attribute

Type

Description

id

String

The unique identifier for the contact which is given by Intercom

Request Body Parameter

Attribute

Type

Description

id

String

The unique identifier for the subscription type which is given by Intercom

consent_type

String

The consent_type of a subscription, opt_out or opt_in.

Response

This will return a Subscription Type model for the subscription type that was added to the contact.