Attach a contact to a subscription type

Example Request & Response

$ curl https://api.intercom.io/contacts/<id>/subscriptions \\\n-X POST \\\n-H 'Authorization:Bearer <Your access token>' \\\n-H 'Accept:application/json' \\\n-H 'Content-Type: application/json' -d\n\n{\n  \"id\": \"1\",\n  \"consent_type\": \"opt_out\"\n}

Example Errors

HTTP/1.1 404 NOT FOUND\n{\n  \"type\": \"error.list\",\n  \"request_id\": \"9a3d0816-9707-4598-977e-c009ba630148\",\n  \"errors\": [\n    {\n      \"code\": \"not_found\",\n      \"message\": \"User Not Found\"\n    }\n  ]\n}
HTTP/1.1 404 NOT FOUND\n{\n  \"type\": \"error.list\",\n  \"request_id\": \"060932ab-ab9d-4f89-88f3-d0152d005873\",\n  \"errors\": [\n    {\n      \"code\": \"not_found\",\n      \"message\": \"Resource Not Found\"\n    }\n  ]\n}

You can opt out a single contact.

Request Path Parameter

KeyTypeRequiredDescription
idStringYes

Request Body Parameter

KeyTypeRequiredDescription
idStringYesThe unique identifier for the subscription type which is given by Intercom
consent_typeStringYesThe consent_type of the subscription, currently only opt_out is supported.

Response

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