Intercom: Attach Subscription Type To Contact

Opt an Intercom contact in or out of a subscription type, such as an email newsletter.

Tool ID: intercom_attach_subscription_type_to_contact

Run this action

Use the TypeScript SDK for one call. Use ctx.tools.execute(...) inside a Play for durable calls, scheduled calls, or CSV processing.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'intercom_attach_subscription_type_to_contact',
  {
    "contact_id": "contact_123",
    "id": "id_123",
    "consent_type": "example"
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute intercom_attach_subscription_type_to_contact --input '{
  "contact_id": "contact_123",
  "id": "id_123",
  "consent_type": "example"
}' --json

Example response

The SDK returns this shape at result.toolResponse.raw. The example values illustrate the response.

{
  "data": {
    "type": "example",
    "id": "id_123",
    "state": "live"
  }
}

Use deepline describe intercom_attach_subscription_type_to_contact --json for the latest machine-readable contract.

Input reference

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.

Name	Type	Required	Default	Details
`payload.contact_id`	`string`	Yes	—	The unique identifier for the contact which is given by Intercom
`payload.id`	`string`	Yes	—	The unique identifier for the subscription which is given by Intercom
`payload.consent_type`	`string`	Yes	—	The consent_type of a subscription, opt_out or opt_in.

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	A subscription type lets customers easily opt out of non-essential communications without missing what’s important to them.
`result.data.type`	`string`	No	—	The type of the object - subscription
`result.data.id`	`string`	No	—	The unique identifier representing the subscription type.
`result.data.state`	`"live" \| "draft" \| "archived"`	No	—	The state of the subscription type. Allowed: `live`, `draft`, `archived`.
`result.data.default_translation`	`object`	No	—	A translation object contains the localised details of a subscription type.
`result.data.default_translation.name`	`string`	No	—	The localised name of the subscription type.
`result.data.default_translation.description`	`string`	No	—	The localised description of the subscription type.
`result.data.default_translation.locale`	`string`	No	—	The two character identifier for the language of the translation object.
`result.data.translations`	`array`	No	—	An array of translations objects with the localised version of the subscription type in each available locale within your translation settings.
`result.data.translations[].name`	`string`	No	—	The localised name of the subscription type.
`result.data.translations[].description`	`string`	No	—	The localised description of the subscription type.
`result.data.translations[].locale`	`string`	No	—	The two character identifier for the language of the translation object.
`result.data.consent_type`	`"opt_out" \| "opt_in"`	No	—	Describes the type of consent. Allowed: `opt_out`, `opt_in`.
`result.data.content_types`	`array`	No	—	The message types that this subscription supports - can contain `email` or `sms_message`.
`result.meta`	`object`	No	—	Additional response metadata (status, paging).

Deepline cost

Pricing model: fixed (per call).
Estimated Deepline credits: 0 per pricing unit.
Provider-native pricing may still exist outside Deepline credit billing.

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation