Skip to main content
Intercom logo
  • Category: customer support
  • Auth: OAUTH2
  • Composio-managed OAuth available? Yes
  • Tools: 133
  • Triggers: 0
  • Slug: INTERCOM
  • Version: 20261101_00

Tools

Slug: INTERCOM_ADD_SUBSCRIPTION_TO_A_CONTACTYou 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.

Input Parameters

string
required
The unique identifier for the subscription which is given by Intercom
string
required
The unique identifier for the contact which is given by Intercom
The consent_type of a subscription, opt_out or opt_in.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_ADD_TAG_TO_CONTACTTool to add a tag to a contact in Intercom. Use when you need to attach or add a specific tag to a contact for categorization or tracking purposes.

Input Parameters

string
required
The unique identifier for the tag which is given by Intercom
string
required
The unique identifier for the contact which is given by Intercom

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_ARCHIVE_CONTACTTool to archive a single contact in Intercom. Use when you need to archive a contact by their ID.

Input Parameters

string
required
The unique identifier for the contact to archive

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_ASSIGN_CONVERSATIONAssigns a conversation to a specific admin or team in Intercom. Mutates live conversation state; confirm intent before bulk-assigning multiple conversations.

Input Parameters

string
ID of the team to assign the conversation to. Either admin_id or team_id must be provided
string
ID of the admin to assign the conversation to. Either admin_id or team_id must be provided
string
ID of the admin making the assignment (who is performing this action)
string
required
The ID of the conversation to assign

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_ATTACH_CONTACT_TO_COMPANYTool to attach a contact to a company in Intercom. Use when you need to associate a contact with a company.

Input Parameters

string
required
The unique identifier for the company which is given by Intercom
string
required
The unique identifier for the contact which is given by Intercom

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_ATTACH_CONTACT_TO_CONVERSATIONAttaches a contact participant to an existing Intercom conversation on behalf of an admin.

Input Parameters

string
required
The id of the admin who is adding the new participant
object
required
Object containing contact identifier. Must include at least one of: id, intercom_user_id, user_id, or email
string
required
The identifier for the conversation as given by Intercom

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_ATTACH_TAG_TO_CONVERSATIONTool to add a tag to a specific conversation in Intercom. Use when you need to attach or tag a conversation.

Input Parameters

string
required
The unique identifier for the tag which is given by Intercom
string
required
The unique identifier for the admin which is given by Intercom
string
required
The unique identifier for the conversation

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_ATTACH_TAG_TO_TICKETTool to add a tag to a ticket in Intercom. Use when you need to attach or add a specific tag to a ticket for categorization or tracking purposes.

Input Parameters

string
required
The unique identifier for the tag which is given by Intercom
string
required
The unique identifier for the admin which is given by Intercom
string
required
The unique identifier for the ticket which is given by Intercom

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_BLOCK_CONTACTTool to block a single contact in Intercom. Use when you need to block a contact, which will also archive their conversations.

Input Parameters

string
required
The unique identifier for the contact to block

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_CANCEL_DATA_EXPORTTool to cancel an active content data export job. Use when you need to terminate an ongoing export and update its status to ‘canceled’.

Input Parameters

string
required
The unique identifier for the export job to cancel.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_CLOSE_CONVERSATIONCloses an Intercom conversation as an admin, optionally including a closing message. Closing requires a separate reopen action to reverse.

Input Parameters

string
Optional message to send when closing the conversation
string
required
ID of the admin closing the conversation
string
required
The ID of the conversation to close Conversation must be in open state; verify state via INTERCOM_GET_CONVERSATION first, as closing a snoozed or already-closed conversation produces unexpected results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_CREATE_A_COLLECTIONYou can create a new collection by making a POST request to https://api.intercom.io/help_center/collections.

Input Parameters

string
required
The name of the collection. For multilingual collections, this will be the name of the default language”s content.
string
The id of the parent collection. If null then it will be created as the first level collection.
string
The description of the collection. For multilingual collections, this will be the description of the default language”s content.
integer
The id of the help center where the collection will be created. If null then it will be created in the default help center.
string ("None" | "group_translated_content")
The type of object - group_translated_content.
string
The name of the collection or section.
string ("None" | "group_content")
The type of object - group_content .
string
The name of the collection or section.
string ("None" | "group_content")
The type of object - group_content .
string
The name of the collection or section.
string ("None" | "group_content")
The type of object - group_content .
string
The name of the collection or section.
string ("None" | "group_content")
The type of object - group_content .
string
The name of the collection or section.
string ("None" | "group_content")
The type of object - group_content .
string
The name of the collection or section.
string ("None" | "group_content")
The type of object - group_content .
string
The name of the collection or section.
string ("None" | "group_content")
The type of object - group_content .
string
The name of the collection or section.
string ("None" | "group_content")
The type of object - group_content .
string
The name of the collection or section.
string ("None" | "group_content")
The type of object - group_content .
string
The name of the collection or section.
string ("None" | "group_content")
The type of object - group_content .
string
The name of the collection or section.
string ("None" | "group_content")
The type of object - group_content .
string
The name of the collection or section.
string ("None" | "group_content")
The type of object - group_content .
string
The name of the collection or section.
string ("None" | "group_content")
The type of object - group_content .
string
The name of the collection or section.
string ("None" | "group_content")
The type of object - group_content .
string
The name of the collection or section.
string ("None" | "group_content")
The type of object - group_content .
string
The name of the collection or section.
string ("None" | "group_content")
The type of object - group_content .
string
The name of the collection or section.
string ("None" | "group_content")
The type of object - group_content .
string
The name of the collection or section.
string ("None" | "group_content")
The type of object - group_content .
string
The name of the collection or section.
string ("None" | "group_content")
The type of object - group_content .
string
The name of the collection or section.
string ("None" | "group_content")
The type of object - group_content .
string
The name of the collection or section.
string ("None" | "group_content")
The type of object - group_content .
string
The name of the collection or section.
string ("None" | "group_content")
The type of object - group_content .
string
The name of the collection or section.
string ("None" | "group_content")
The type of object - group_content .
string
The name of the collection or section.
string ("None" | "group_content")
The type of object - group_content .
string
The name of the collection or section.
string ("None" | "group_content")
The type of object - group_content .
string
The name of the collection or section.
string ("None" | "group_content")
The type of object - group_content .
string
The name of the collection or section.
string ("None" | "group_content")
The type of object - group_content .
string
The name of the collection or section.
string ("None" | "group_content")
The type of object - group_content .
string
The name of the collection or section.
string ("None" | "group_content")
The type of object - group_content .
string
The name of the collection or section.
string ("None" | "group_content")
The type of object - group_content .
string
The name of the collection or section.
string ("None" | "group_content")
The type of object - group_content .
string
The name of the collection or section.
string ("None" | "group_content")
The type of object - group_content .
string
The name of the collection or section.
string ("None" | "group_content")
The type of object - group_content .
string
The name of the collection or section.
string ("None" | "group_content")
The type of object - group_content .
string
The name of the collection or section.
string ("None" | "group_content")
The type of object - group_content .
string
The name of the collection or section.
string ("None" | "group_content")
The type of object - group_content .
string
The name of the collection or section.
string ("None" | "group_content")
The type of object - group_content .
string
The description of the collection. Only available for collections.
string
The description of the collection. Only available for collections.
string
The description of the collection. Only available for collections.
string
The description of the collection. Only available for collections.
string
The description of the collection. Only available for collections.
string
The description of the collection. Only available for collections.
string
The description of the collection. Only available for collections.
string
The description of the collection. Only available for collections.
string
The description of the collection. Only available for collections.
string
The description of the collection. Only available for collections.
string
The description of the collection. Only available for collections.
string
The description of the collection. Only available for collections.
string
The description of the collection. Only available for collections.
string
The description of the collection. Only available for collections.
string
The description of the collection. Only available for collections.
string
The description of the collection. Only available for collections.
string
The description of the collection. Only available for collections.
string
The description of the collection. Only available for collections.
string
The description of the collection. Only available for collections.
string
The description of the collection. Only available for collections.
string
The description of the collection. Only available for collections.
string
The description of the collection. Only available for collections.
string
The description of the collection. Only available for collections.
string
The description of the collection. Only available for collections.
string
The description of the collection. Only available for collections.
string
The description of the collection. Only available for collections.
string
The description of the collection. Only available for collections.
string
The description of the collection. Only available for collections.
string
The description of the collection. Only available for collections.
string
The description of the collection. Only available for collections.
string
The description of the collection. Only available for collections.
string
The description of the collection. Only available for collections.
string
The description of the collection. Only available for collections.
string
The description of the collection. Only available for collections.
string
The description of the collection. Only available for collections.
string
The description of the collection. Only available for collections.
string
The description of the collection. Only available for collections.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_CREATE_AN_ARTICLEYou can create a new article by making a POST request to https://api.intercom.io/articles.

Input Parameters

string
The content of the article. For multilingual articles, this will be the body of the default language”s content.
string ("published" | "draft")
Whether the article will be published or will be a draft. Defaults to draft. For multilingual articles, this will be the state of the default language”s content.
string
required
The title of the article.For multilingual articles, this will be the title of the default language”s content.
integer
required
The id of the author of the article. For multilingual articles, this will be the id of the author of the default language”s content. Must be a teammate on the help center”s workspace.
integer
The id of the article”s parent collection or section. An article without this field stands alone.
string
The description of the article. For multilingual articles, this will be the description of the default language”s content.
string
The type of parent, which can either be a collection or section.
string ("None" | "article_translated_content")
The type of object - article_translated_content.
string
The URL of the article.
string
The URL of the article.
string
The URL of the article.
string
The URL of the article.
string
The URL of the article.
string
The URL of the article.
string
The URL of the article.
string
The URL of the article.
string
The URL of the article.
string
The URL of the article.
string
The URL of the article.
string
The URL of the article.
string
The URL of the article.
string
The URL of the article.
string
The URL of the article.
string
The URL of the article.
string
The URL of the article.
string
The URL of the article.
string
The URL of the article.
string
The URL of the article.
string
The URL of the article.
string
The URL of the article.
string
The URL of the article.
string
The URL of the article.
string
The URL of the article.
string
The URL of the article.
string
The URL of the article.
string
The URL of the article.
string
The URL of the article.
string
The URL of the article.
string
The URL of the article.
string
The URL of the article.
string
The URL of the article.
string
The URL of the article.
string
The body of the article.
string ("None" | "article_content")
The type of object - article_content .
string
The body of the article.
string ("None" | "article_content")
The type of object - article_content .
string
The body of the article.
string ("None" | "article_content")
The type of object - article_content .
string
The body of the article.
string ("None" | "article_content")
The type of object - article_content .
string
The body of the article.
string ("None" | "article_content")
The type of object - article_content .
string
The body of the article.
string ("None" | "article_content")
The type of object - article_content .
string
The body of the article.
string ("None" | "article_content")
The type of object - article_content .
string
The body of the article.
string ("None" | "article_content")
The type of object - article_content .
string
The body of the article.
string ("None" | "article_content")
The type of object - article_content .
string
The body of the article.
string ("None" | "article_content")
The type of object - article_content .
string
The body of the article.
string ("None" | "article_content")
The type of object - article_content .
string
The body of the article.
string ("None" | "article_content")
The type of object - article_content .
string
The body of the article.
string ("None" | "article_content")
The type of object - article_content .
string
The body of the article.
string ("None" | "article_content")
The type of object - article_content .
string
The body of the article.
string ("None" | "article_content")
The type of object - article_content .
string
The body of the article.
string ("None" | "article_content")
The type of object - article_content .
string
The body of the article.
string ("None" | "article_content")
The type of object - article_content .
string
The body of the article.
string ("None" | "article_content")
The type of object - article_content .
string
The body of the article.
string ("None" | "article_content")
The type of object - article_content .
string
The body of the article.
string ("None" | "article_content")
The type of object - article_content .
string
The body of the article.
string ("None" | "article_content")
The type of object - article_content .
string
The body of the article.
string ("None" | "article_content")
The type of object - article_content .
string
The body of the article.
string ("None" | "article_content")
The type of object - article_content .
string
The body of the article.
string ("None" | "article_content")
The type of object - article_content .
string
The body of the article.
string ("None" | "article_content")
The type of object - article_content .
string
The body of the article.
string ("None" | "article_content")
The type of object - article_content .
string
The body of the article.
string ("None" | "article_content")
The type of object - article_content .
string
The body of the article.
string ("None" | "article_content")
The type of object - article_content .
string
The body of the article.
string ("None" | "article_content")
The type of object - article_content .
string
The body of the article.
string ("None" | "article_content")
The type of object - article_content .
string
The body of the article.
string ("None" | "article_content")
The type of object - article_content .
string
The body of the article.
string ("None" | "article_content")
The type of object - article_content .
string
The body of the article.
string ("None" | "article_content")
The type of object - article_content .
string
The body of the article.
string ("None" | "article_content")
The type of object - article_content .
string ("published" | "draft")
Whether the article is published or is a draft .
string
The title of the article.
string ("published" | "draft")
Whether the article is published or is a draft .
string
The title of the article.
string ("published" | "draft")
Whether the article is published or is a draft .
string
The title of the article.
string ("published" | "draft")
Whether the article is published or is a draft .
string
The title of the article.
string ("published" | "draft")
Whether the article is published or is a draft .
string
The title of the article.
string ("published" | "draft")
Whether the article is published or is a draft .
string
The title of the article.
string ("published" | "draft")
Whether the article is published or is a draft .
string
The title of the article.
string ("published" | "draft")
Whether the article is published or is a draft .
string
The title of the article.
string ("published" | "draft")
Whether the article is published or is a draft .
string
The title of the article.
string ("published" | "draft")
Whether the article is published or is a draft .
string
The title of the article.
string ("published" | "draft")
Whether the article is published or is a draft .
string
The title of the article.
string ("published" | "draft")
Whether the article is published or is a draft .
string
The title of the article.
string ("published" | "draft")
Whether the article is published or is a draft .
string
The title of the article.
string ("published" | "draft")
Whether the article is published or is a draft .
string
The title of the article.
string ("published" | "draft")
Whether the article is published or is a draft .
string
The title of the article.
string ("published" | "draft")
Whether the article is published or is a draft .
string
The title of the article.
string ("published" | "draft")
Whether the article is published or is a draft .
string
The title of the article.
string ("published" | "draft")
Whether the article is published or is a draft .
string
The title of the article.
string ("published" | "draft")
Whether the article is published or is a draft .
string
The title of the article.
string ("published" | "draft")
Whether the article is published or is a draft .
string
The title of the article.
string ("published" | "draft")
Whether the article is published or is a draft .
string
The title of the article.
string ("published" | "draft")
Whether the article is published or is a draft .
string
The title of the article.
string ("published" | "draft")
Whether the article is published or is a draft .
string
The title of the article.
string ("published" | "draft")
Whether the article is published or is a draft .
string
The title of the article.
string ("published" | "draft")
Whether the article is published or is a draft .
string
The title of the article.
string ("published" | "draft")
Whether the article is published or is a draft .
string
The title of the article.
string ("published" | "draft")
Whether the article is published or is a draft .
string
The title of the article.
string ("published" | "draft")
Whether the article is published or is a draft .
string
The title of the article.
string ("published" | "draft")
Whether the article is published or is a draft .
string
The title of the article.
string ("published" | "draft")
Whether the article is published or is a draft .
string
The title of the article.
string ("published" | "draft")
Whether the article is published or is a draft .
string
The title of the article.
string ("published" | "draft")
Whether the article is published or is a draft .
string
The title of the article.
string ("published" | "draft")
Whether the article is published or is a draft .
string
The title of the article.
string ("published" | "draft")
Whether the article is published or is a draft .
string
The title of the article.
string
The URL of the article.
string
The URL of the article.
string
The URL of the article.
string
The body of the article.
string ("None" | "article_content")
The type of object - article_content .
string
The body of the article.
string ("None" | "article_content")
The type of object - article_content .
string
The body of the article.
string ("None" | "article_content")
The type of object - article_content .
string ("published" | "draft")
Whether the article is published or is a draft .
string
The title of the article.
string ("published" | "draft")
Whether the article is published or is a draft .
string
The title of the article.
string ("published" | "draft")
Whether the article is published or is a draft .
string
The title of the article.
integer
The ID of the author of the article.
integer
The ID of the author of the article.
integer
The ID of the author of the article.
integer
The ID of the author of the article.
integer
The ID of the author of the article.
integer
The ID of the author of the article.
integer
The ID of the author of the article.
integer
The ID of the author of the article.
integer
The ID of the author of the article.
integer
The ID of the author of the article.
integer
The ID of the author of the article.
integer
The ID of the author of the article.
integer
The ID of the author of the article.
integer
The ID of the author of the article.
integer
The ID of the author of the article.
integer
The ID of the author of the article.
integer
The ID of the author of the article.
integer
The ID of the author of the article.
integer
The ID of the author of the article.
integer
The ID of the author of the article.
integer
The ID of the author of the article.
integer
The ID of the author of the article.
integer
The ID of the author of the article.
integer
The ID of the author of the article.
integer
The ID of the author of the article.
integer
The ID of the author of the article.
integer
The ID of the author of the article.
integer
The ID of the author of the article.
integer
The ID of the author of the article.
integer
The ID of the author of the article.
integer
The ID of the author of the article.
integer
The ID of the author of the article.
integer
The ID of the author of the article.
integer
The ID of the author of the article.
integer
The time when the article was created (seconds).
string
The description of the article.
integer
The time when the article was last updated (seconds).
integer
The time when the article was created (seconds).
string
The description of the article.
integer
The time when the article was last updated (seconds).
integer
The time when the article was created (seconds).
string
The description of the article.
integer
The time when the article was last updated (seconds).
integer
The time when the article was created (seconds).
string
The description of the article.
integer
The time when the article was last updated (seconds).
integer
The time when the article was created (seconds).
string
The description of the article.
integer
The time when the article was last updated (seconds).
integer
The time when the article was created (seconds).
string
The description of the article.
integer
The time when the article was last updated (seconds).
integer
The time when the article was created (seconds).
string
The description of the article.
integer
The time when the article was last updated (seconds).
integer
The time when the article was created (seconds).
string
The description of the article.
integer
The time when the article was last updated (seconds).
integer
The time when the article was created (seconds).
string
The description of the article.
integer
The time when the article was last updated (seconds).
integer
The time when the article was created (seconds).
string
The description of the article.
integer
The time when the article was last updated (seconds).
integer
The time when the article was created (seconds).
string
The description of the article.
integer
The time when the article was last updated (seconds).
integer
The time when the article was created (seconds).
string
The description of the article.
integer
The time when the article was last updated (seconds).
integer
The time when the article was created (seconds).
string
The description of the article.
integer
The time when the article was last updated (seconds).
integer
The time when the article was created (seconds).
string
The description of the article.
integer
The time when the article was last updated (seconds).
integer
The time when the article was created (seconds).
string
The description of the article.
integer
The time when the article was last updated (seconds).
integer
The time when the article was created (seconds).
string
The description of the article.
integer
The time when the article was last updated (seconds).
integer
The time when the article was created (seconds).
string
The description of the article.
integer
The time when the article was last updated (seconds).
integer
The time when the article was created (seconds).
string
The description of the article.
integer
The time when the article was last updated (seconds).
integer
The time when the article was created (seconds).
string
The description of the article.
integer
The time when the article was last updated (seconds).
integer
The time when the article was created (seconds).
string
The description of the article.
integer
The time when the article was last updated (seconds).
integer
The time when the article was created (seconds).
string
The description of the article.
integer
The time when the article was last updated (seconds).
integer
The time when the article was created (seconds).
string
The description of the article.
integer
The time when the article was last updated (seconds).
integer
The time when the article was created (seconds).
string
The description of the article.
integer
The time when the article was last updated (seconds).
integer
The time when the article was created (seconds).
string
The description of the article.
integer
The time when the article was last updated (seconds).
integer
The time when the article was created (seconds).
string
The description of the article.
integer
The time when the article was last updated (seconds).
integer
The time when the article was created (seconds).
string
The description of the article.
integer
The time when the article was last updated (seconds).
integer
The time when the article was created (seconds).
string
The description of the article.
integer
The time when the article was last updated (seconds).
integer
The time when the article was created (seconds).
string
The description of the article.
integer
The time when the article was last updated (seconds).
integer
The time when the article was created (seconds).
string
The description of the article.
integer
The time when the article was last updated (seconds).
integer
The time when the article was created (seconds).
string
The description of the article.
integer
The time when the article was last updated (seconds).
integer
The time when the article was created (seconds).
string
The description of the article.
integer
The time when the article was last updated (seconds).
integer
The time when the article was created (seconds).
string
The description of the article.
integer
The time when the article was last updated (seconds).
integer
The time when the article was created (seconds).
string
The description of the article.
integer
The time when the article was last updated (seconds).
integer
The time when the article was created (seconds).
string
The description of the article.
integer
The time when the article was last updated (seconds).
integer
The ID of the author of the article.
integer
The ID of the author of the article.
integer
The ID of the author of the article.
integer
The time when the article was created (seconds).
string
The description of the article.
integer
The time when the article was last updated (seconds).
integer
The time when the article was created (seconds).
string
The description of the article.
integer
The time when the article was last updated (seconds).
integer
The time when the article was created (seconds).
string
The description of the article.
integer
The time when the article was last updated (seconds).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_CREATE_A_NOTEYou can add a note to a single contact.

Input Parameters

string
required
The unique identifier of a given contact.
string
required
The text of the note.
string
The unique identifier of a given admin.
string
The unique identifier of a given contact.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_CREATE_CONTACTTool to create a new contact in Intercom workspace. Use when you need to add a user or lead to Intercom. At least one identifier (email, external_id, or role) must be provided.

Input Parameters

string
Contact’s full name
string
The contact’s role designation (user/lead). At least one identifier (email, external_id, or role) must be provided.
string
The contact’s email address. At least one identifier (email, external_id, or role) must be provided.
string
Contact phone number (E.164 format recommended, e.g., +353871234567)
string
Image URL for the contact’s avatar
integer
Admin ID assigned as account owner
string
A unique identifier from your system. At least one identifier (email, external_id, or role) must be provided.
integer
Unix timestamp of last activity
integer
Unix timestamp of signup date
object
Custom key-value data fields
boolean
Email subscription status

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_CREATE_CONTENT_IMPORT_SOURCETool to create a new content import source for the Fin Content Library. Use when you need to create a container for External Pages to be ingested into Intercom’s AI content system.

Input Parameters

string
required
The URL of the content import source. Must be a valid URL.
string ("active" | "deactivated")
The status of the content import source. Defaults to ‘active’.
string ("api" | "automatic" | "manual")
required
Defines sync method.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_CREATE_CONVERSATIONCreates a new Intercom conversation from a user or contact. At least one user or contact ID is required; if both are supplied, the user ID takes precedence.

Input Parameters

string
required
The message content for the conversation
string
Subject line for the conversation
string
ID of the user to create the conversation from. Either from_user_id or from_contact_id is required
string
Type of message: inapp, email, or facebook
string
ID of the admin creating the conversation. If not provided, uses authenticated admin
string
ID of the contact to create the conversation from. Either from_user_id or from_contact_id is required

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_CREATE_DATA_ATTRIBUTETool to create a custom data attribute for contacts or companies. Use when you need to define a new attribute to track additional information beyond standard fields.

Input Parameters

string
required
The identifier for the data attribute. This will be the key used to reference the attribute.
string ("contact" | "company")
required
Specifies which object type this attribute applies to. Must be either ‘contact’ or ‘company’.
array
Required when data_type is ‘options’. Array of option objects, each containing a ‘value’ property.
string ("string" | "integer" | "float" | "boolean" | "date")
required
The type of data stored. Valid values: ‘string’, ‘integer’, ‘float’, ‘boolean’, or ‘date’.
string
A readable description of the attribute shown in the UI. Helps users understand the purpose of the attribute.
boolean
Whether the Messenger can update this attribute. Set to true to allow updates via Messenger.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_CREATE_DATA_EVENTTool to submit a data event to Intercom to track user activities. Use when you need to notify Intercom of user actions and changes. Events are detected as duplicates using workspace ID, contact identifier, event name, and timestamp.

Input Parameters

string
Intercom’s 24-character UUID identifier for a lead or user. The contact must already exist in Intercom; events cannot be created for non-existent contacts. At least one of user_id, id, or email is required.
string
The user’s email address. The contact with this email must already exist in Intercom; events cannot be created for non-existent contacts. Use only when email uniquely identifies users. At least one of user_id, id, or email is required.
string
Your application’s unique identifier for the user. The contact must already exist in Intercom with this user_id; events cannot be created for non-existent contacts. At least one of user_id, id, or email is required.
object
Additional key-value pairs providing context about the event. Can include custom properties relevant to the event.
integer
required
Unix timestamp indicating when the event occurred.
string
required
The name of the event in past tense verb-noun format (e.g., ‘updated-plan’, ‘purchased-item’). Describes what action occurred.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_CREATE_DATA_EXPORTTool to initiate an async data export job for message content. Use when you need to export messages created within a specific timeframe. Only one active job per workspace is allowed; exceeding this limit triggers a 429 error. Jobs expire two days after completion.

Input Parameters

integer
required
Start date for data export; must be formatted as a UNIX timestamp. Only messages created after this time will be included.
integer
required
End date for data export; formatted as UNIX timestamp. This parameter is required by the API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_CREATE_EXTERNAL_PAGETool to create an external page in Fin Content Library or update an existing page by external ID. Use when you need to ingest new content or update existing content for AI-generated answers. Supports upsert behavior: if a page with the same source_id and external_id exists, it will be updated instead of creating a new one.

Input Parameters

string
required
The page URL; used by Fin to attribute answers to sources. Must be a valid URL.
string
required
The body content of the external page in HTML format
string
required
The title of the external page
string
required
Language code for the page. Must be ‘en’.
integer
required
Identifier for the content import source. This links the page to a specific content import source in your workspace.
string
required
Unique ID from the source; enables upsert functionality. If a page with the same source_id and external_id exists, it will be updated instead of creating a new one.
boolean
Whether Fin AI Agent can reference this content. Defaults to false if not provided.
boolean
Whether AI Copilot can use this content. Defaults to false if not provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_CREATE_HELP_CENTER_SECTIONTool to create a new help center section within a collection. Use when you need to add a new section to organize articles in the help center hierarchy (Help Center → Collections → Sections → Articles). Supports multilingual content via translated_content parameter.

Input Parameters

string
required
The name of the section. For multilingual sections, this will be the name of the default language’s content.
string
required
The collection ID where the section will be located.
object
A dictionary of locale codes to translated content. Keys are locale codes (e.g., ‘es’, ‘fr’, ‘de’). Each value contains the translated name and optional description for that locale.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_CREATE_INTERNAL_ARTICLETool to create a new internal article for team knowledge sharing. Use when you need to add new internal documentation or knowledge base articles for team members.

Input Parameters

string
The content of the article (supports HTML).
string
required
The title of the article.
string
Language/locale identifier for the article content.
integer
required
The id of the owner of the article.
integer
required
The id of the author of the article.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_CREATE_OR_UPDATE_A_COMPANYYou can create or update a company. Companies will be only visible in Intercom when there is at least one associated user. Companies are looked up via company_id in a POST request, if not found via company_id, the new company will be created, if found, that company will be updated. {% admonition type=“attention” name=“Using company_id” %} You can set a unique company_id value when creating a company. However, it is not possible to update company_id. Be sure to set a unique value once upon creation of the company. {% /admonition %}

Input Parameters

string
The name of the Company
string
The name of the plan you have associated with the company.
integer
The number of employees in this company.
string
The URL for this company”s website. Please note that the value specified here is not validated. Accepts any string.
string
The industry that this company operates in.
string
The company id you have defined for the company. Can”t be updated
integer
How much revenue the company generates for your business. Note that this will truncate floats. i.e. it only allow for whole integers, 155.98 will be truncated to 155. Note that this has an upper limit of 2**31-1 or 2147483647..
object
A hash of key/value pairs containing any other data about the company you want Intercom to store. Values must be strings, numbers, or booleans (not objects or arrays).
integer
The time the company was created by you.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_CREATE_TAGCreate or update a tag, optionally applying or removing it from companies or applying it to users.

Input Parameters

string
The ID of an existing tag to update. Optional - only needed when updating a specific tag.
string
required
The name of the tag. Will be created if it doesn’t exist, or the existing tag will be used if it does.
array
Optional list of users to tag. Each user must have an ‘id’ field.
array
Optional list of companies to tag or untag. Each company should have either ‘id’ or ‘company_id’ field, and optionally ‘untag’: true to remove the tag.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_CREATE_TICKETTool to create a ticket in Intercom to track customer requests and issues. Use when you need to create a new support ticket with specified type, contacts, and attributes.

Input Parameters

array
required
Array of contact objects representing users affected by this ticket. Each contact must include one of: id, external_id, or email
object
Assignment information for the ticket
string
The ID of the company associated with this ticket
integer
Unix timestamp indicating when the ticket was created. Defaults to current time if not provided
string
required
The ID of the ticket type you want to create. This defines the structure and workflow for the ticket
object
Custom attribute key-value pairs for the ticket. Use ‘default_title’ for the ticket title and ‘default_description’ for the ticket description. Additional custom fields depend on your ticket type configuration
The ID of an existing conversation to link to this ticket

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_CREATE_TICKET_TYPECreate a new ticket type for tracking customer requests, specifying its name and category and optionally its description, icon, and internal status.

Input Parameters

string
Emoji representation (from Twemoji Cheatsheet)
string
required
The designation for the ticket type
string
required
Classification as ‘Customer’, ‘Back-office’, or ‘Tracker’ (required)
string
Explanatory text about the ticket type
boolean
Whether tickets are for internal use only; defaults to false

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_CREATE_TICKET_TYPE_ATTRIBUTETool to create a new attribute for a ticket type in Intercom. Use when you need to add custom attributes to ticket types for data collection.

Input Parameters

string
required
The name of the ticket type attribute
string ("string" | "list" | "integer" | "decimal" | "boolean" | "datetime" | "files")
required
The data type of the attribute. Allowed values: string, list, integer, decimal, boolean, datetime, files
boolean
Whether the attribute allows multiple lines of text (applicable for string data_type only)
string
A comma delimited list of items for the attribute value (applicable for list data_type only)
string
required
The description of the attribute presented to the teammate or contact
string
required
The unique identifier of the ticket type to add the attribute to
boolean
Visibility to teammates during creation (default: true)
boolean
Whether teammates must fill this attribute when creating tickets (default: false)
boolean
Visibility to contacts in Messenger (default: true)
boolean
Whether the attribute allows multiple files to be attached (applicable for files data_type only)
boolean
Whether contacts must fill this attribute in Messenger (default: false)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_DATA_EVENT_SUMMARIESTool to create event summaries for a user to track event occurrences. Use when you need to bulk update event counts for a user.

Input Parameters

string
required
Your identifier for the user to create event summaries for
array
required
List of event summaries to create for the user

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_DELETE_A_COLLECTIONDelete a single collection by ID using a DELETE request to /help_center/collections/{id}.

Input Parameters

integer
required
The unique identifier for the collection which is given by Intercom.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_DELETE_A_COMPANYYou can delete a single company.

Input Parameters

string
required
The unique identifier for the company which is given by Intercom

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_DELETE_AN_ARTICLEYou can delete a single article by making a DELETE request to https://api.intercom.io/articles/<id>.

Input Parameters

integer
required
The unique identifier for the article which is given by Intercom.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_DELETE_A_TAG_DELETE_TAGTool to delete a tag from Intercom workspace. Use when you need to permanently remove a tag that is no longer needed.

Input Parameters

string
required
The unique identifier of the tag to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_DELETE_A_VISITORTool to delete a visitor from the Intercom workspace. Use when you need to permanently remove a visitor record.

Input Parameters

string
required
The unique identifier for the visitor which is given by Intercom

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_DELETE_CONTACTTool to delete a contact from the Intercom workspace. Use when you need to permanently remove a contact record.

Input Parameters

string
required
The unique identifier for the contact which is given by Intercom

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_DELETE_CONTENT_IMPORT_SOURCETool to delete a content import source and all its external pages. Use when you need to remove a content import source from Intercom. This operation is permanent and cannot be undone.

Input Parameters

string
required
The unique identifier for the content import source which is given by Intercom.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_DELETE_CONVERSATIONPermanently delete an Intercom conversation while retaining reporting metrics.

Input Parameters

boolean
Must be true. Deletes the conversation while retaining its reporting metrics; deleting metrics is intentionally not supported by this action.
string
required
The unique identifier for the conversation assigned by Intercom

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_DELETE_EXTERNAL_PAGETool to delete an external page from content library and AI answers. Use when you need to remove an external page from Intercom’s AI knowledge base.

Input Parameters

string
required
The unique identifier for the external page provided by Intercom

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_DELETE_INTERNAL_ARTICLETool to delete a single internal article by ID. Use when you need to permanently remove an internal article from Intercom.

Input Parameters

integer
required
The unique identifier for the internal article which is given by Intercom.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_DELETE_TICKETTool to delete a ticket from the Intercom system. Use when you need to permanently remove a ticket.

Input Parameters

string
required
The unique identifier for the ticket assigned by Intercom

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_DETACH_A_CONTACTTool to remove a tag from a specific contact in Intercom. Use when you need to detach or untag a contact.

Input Parameters

string
required
The unique identifier for the tag which is given by Intercom
string
required
The unique identifier for the contact which is given by Intercom

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_DETACH_CONTACT_FROM_COMPANYTool to detach a contact from a company in Intercom. Use when you need to remove a company association from a contact.

Input Parameters

string
required
The unique identifier for the company which is given by Intercom
string
required
The unique identifier for the contact which is given by Intercom

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_DETACH_TAG_FROM_CONVERSATIONTool to remove a tag from a specific conversation in Intercom. Use when you need to detach or untag a conversation.

Input Parameters

string
required
The unique identifier for the tag to be removed
string
required
The unique identifier for the admin which is performing the action
string
required
The unique identifier for the conversation

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_DETACH_TAG_FROM_TICKETTool to remove a tag from a ticket in Intercom. Use when you need to detach or remove a specific tag from a ticket.

Input Parameters

string
required
The unique identifier for the tag which is given by Intercom
string
required
The unique identifier for the admin which is given by Intercom
string
required
The unique identifier for the ticket which is given by Intercom

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_DOWNLOAD_DATA_EXPORTTool to download content data export from Intercom. Use when you need to retrieve exported message data from a completed data export job. The data is returned as a gzipped CSV file stream.

Input Parameters

string
required
The location identifier where you can download your data. This is obtained from the download_url when a content data export job reaches ‘complete’ status.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_ENQUEUE_CREATE_TICKETTool to enqueue ticket creation for asynchronous processing. Use when you need to create a ticket in Intercom. The system attempts validation on inputs before tasks are enqueued.

Input Parameters

array
required
List of contacts affected by the ticket (currently only one allowed). Provide at least one of: id, external_id, or email
object
Optional assignment details for the ticket
string
Associated company identifier
integer
Timestamp for ticket creation (current time if omitted)
string
required
The identifier of the ticket type you want to create
object
Ticket field values as key-value pairs. Default fields: default_title and default_description. Supports strings, numbers, booleans, arrays, and file attributes
boolean
Disable notifications when created
Conversation ID to link to the ticket

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_EXPORT_WORKFLOWExport a complete Intercom workflow configuration by its UI ruleset ID.

Input Parameters

string
required
The ruleset ID, which is the number at the end of the workflow URL in the Intercom UI. This is not the workflow.id returned by this action; do not pass that response ID here.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_FIND_TAGTool to retrieve details for a specific tag by its ID. Use when you need to get information about a particular tag in the workspace.

Input Parameters

string
required
The unique identifier for the tag within the workspace.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_GET_A_CONTACTYou can fetch the details of a single contact.

Input Parameters

string
required
id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_GET_CONTENT_IMPORT_SOURCETool to retrieve a content import source by its ID. Use when you need to fetch details about a specific content import source from Intercom’s AI features.

Input Parameters

string
required
The unique identifier for the content import source which is given by Intercom.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_GET_CONVERSATIONRetrieves an Intercom conversation by ID, including its returned messages and details. The response can contain at most 500 conversation parts; this tool does not provide a cursor for fetching further parts.

Input Parameters

string
Display format for message content: plaintext or html Even with ‘plaintext’, fields like subject and custom_attributes may still contain raw HTML — sanitize separately.
string
required
The ID of the conversation to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_GET_COUNTSTool to retrieve summary counts for Intercom app entities including companies, users, leads, tags, segments, and conversations. Use when you need to get statistics about the total number of entities in the workspace or conversation counts.

Input Parameters

string
Set to ‘conversation’ to retrieve conversation-specific counts. If omitted, returns app total counts (companies, users, leads, tags, segments).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_GET_CUSTOM_OBJECT_INSTANCE_BY_EXTERNAL_IDTool to retrieve a custom object instance by its external_id. Use when you need to fetch a specific custom object instance from Intercom using an identifier from your external system rather than Intercom’s internal ID.

Input Parameters

string
required
The unique identifier for the Custom Object instance in the external system it originated from
string
required
The unique identifier of the custom object type (e.g., ‘Order’, ‘Product’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_GET_EXTERNAL_PAGETool to retrieve an external page from Fin Content Library by ID. Use when you need to fetch details of a specific external page including its content, metadata, and AI availability settings.

Input Parameters

string
required
The unique identifier for the external page provided by Intercom

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_GET_TICKETTool to retrieve a ticket from Intercom. Use when you need to fetch comprehensive details about a specific ticket including state, type, attributes, and contacts.

Input Parameters

string
required
The unique identifier for the ticket assigned by Intercom

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_GET_TICKET_TYPETool to retrieve details for a specific ticket type by its ID. Use when you need to get complete information about a ticket type including its attributes and states.

Input Parameters

string
required
The unique identifier for the ticket type to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_IDENTIFY_AN_ADMINYou can view the currently authorised admin along with the embedded app object (a “workspace” in legacy terminology). > 🚧 Single Sign On > > If you are building a custom “Log in with Intercom” flow for your site, and you call the /me endpoint to identify the logged-in user, you should not accept any sign-ins from users with unverified email addresses as it poses a potential impersonation security risk.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_JOBS_STATUSTool to retrieve the status of job execution. Use when checking progress and outcome of asynchronous operations like data imports or exports.

Input Parameters

string
required
The unique identifier for the job which is given by Intercom

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_LIST_ALL_ACTIVITY_LOGSYou can get a log of activities by all admins in an app.

Input Parameters

string
required
The start date that you request data for. It must be formatted as a UNIX timestamp.
string
The end date that you request data for. It must be formatted as a UNIX timestamp.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_LIST_ALL_ADMINSYou can fetch a list of admins for a given workspace.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_LIST_ALL_ARTICLESFetch a list of Intercom articles, ordered by most recently updated first. The tool returns one page and does not accept a pagination cursor.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_LIST_ALL_COLLECTIONSFetch a list of Help Center collections, ordered by most recently updated first. The tool returns one page and does not accept a pagination cursor.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_LIST_ALL_COMPANIESList companies ordered by last request time, descending by default, excluding companies without associated users. Supports page-number pagination with 15 results per page by default and a 10,000-company iteration limit.

Input Parameters

integer
The page of results to fetch. Defaults to first page
string
asc or desc. Return the companies in ascending or descending order. Defaults to desc
integer
How many results to return per page. Defaults to 15. Maximum allowed value is 60.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_LIST_ALL_HELP_CENTERSYou can list all Help Centers by making a GET request to https://api.intercom.io/help_center/help_centers.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_LIST_ALL_MACROSTool to fetch a list of all macros (saved replies) in your workspace for use in automating responses. The macros are returned in descending order by updated_at. Use when you need to retrieve available macros or sync macro data.

Input Parameters

integer
Number of results to return per page. Controls pagination size.
integer
Unix timestamp to retrieve only macros modified after this time. Useful for incremental syncs.
string
Cursor for pagination - Base64-encoded JSON array containing [updated_at, id] of the last item from previous page. Use this to fetch the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_LIST_ALL_NOTESYou can fetch a list of notes that are associated to a contact.

Input Parameters

string
required
The unique identifier of a contact.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_LIST_ATTACHED_COMPANIES_FOR_CONTACTYou can fetch a list of companies that are associated to a contact.

Input Parameters

string
required
The unique identifier for the contact which is given by Intercom

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_LIST_ATTACHED_CONTACTSFetches a list of contacts associated with an Intercom company. The response includes pagination information.

Input Parameters

string
required
The unique identifier for the company which is given by Intercom

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_LIST_ATTACHED_SEGMENTS_FOR_COMPANIESYou can fetch a list of all segments that belong to a company.

Input Parameters

string
required
The unique identifier for the company which is given by Intercom

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_LIST_ATTACHED_SEGMENTS_FOR_CONTACTYou can fetch a list of segments that are associated to a contact.

Input Parameters

string
required
The unique identifier for the contact which is given by Intercom

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_LIST_AWAY_STATUS_REASONSTool to retrieve all away status reasons for a workspace including deleted ones. Use when you need to list available away status options for team members.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_LIST_CALLSTool to list all phone calls from Intercom with pagination support. Use when you need to retrieve call records, view call history, or iterate through calls.

Input Parameters

integer
The page of results to fetch. Defaults to first page.
integer
How many results to display per page. Defaults to 25. Maximum 25.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_LIST_CALLS_WITH_TRANSCRIPTSTool to retrieve calls by conversation IDs with transcripts when available. Use when you need to get call records with their transcripts for specific conversations. Maximum 20 conversation IDs per request.

Input Parameters

array
required
A list of conversation IDs to fetch calls for. Must contain between 1 and 20 conversation IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_LIST_COMPANY_NOTESLists notes from contacts attached to a specific company. Note retrieval failures for individual contacts can leave the aggregated results incomplete.

Input Parameters

string
required
The unique identifier for the company which is given by Intercom

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_LIST_CONTACTSTool to list all contacts (users or leads) in your Intercom workspace with pagination support. Use when you need to retrieve multiple contacts or iterate through all contacts in the workspace.

Input Parameters

integer
Number of results per page. Maximum 150.
string
Pagination cursor to fetch the next page of results. Use the value from pages.next.starting_after in the previous response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_LIST_CONTENT_IMPORT_SOURCESLists a page of content import sources for the workspace’s Fin Content Library, with optional page size and starting cursor. The returned pagination metadata does not include a next cursor.

Input Parameters

integer
Number of items per page. Default: 20, max: 150.
string
Cursor for fetching the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_LIST_CONVERSATIONSLists Intercom conversations with cursor-based pagination. The tool accepts page size and a starting cursor; some returned fields, including title and statistics, may be null.

Input Parameters

integer
Number of conversations per page (1-150)
string
Pagination cursor - ID of the last conversation from previous page

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_LIST_DATA_ATTRIBUTESTool to list all data attributes for contacts, companies, and conversations. Use when you need to retrieve metadata about available data attributes.

Input Parameters

string ("contact" | "company" | "conversation")
Filter attributes by model type. Accepts: ‘contact’, ‘company’, or ‘conversation’
boolean
Include archived attributes in results. Defaults to false (non-archived only)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_LIST_DATA_EVENTSList data events belonging to a specific customer, with optional event summaries. Only events less than 90 days old can be listed; results are collected from at most 50 pages and may be incomplete.

Input Parameters

string
Contact’s email address. Required if user_id and intercom_user_id are not provided.
boolean
Flag to include event summaries in response
string
Your internal identifier for the user. Required if intercom_user_id and email are not provided.
string
Intercom’s identifier for the contact. Required if user_id and email are not provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_LIST_EXTERNAL_PAGESLists a page of external pages from the Fin Content Library, with optional pagination parameters.

Input Parameters

integer
Number of items per page. Default: 20, max: 150.
string
Cursor for fetching the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_LIST_HELP_CENTER_SECTIONSLists a page of help center sections, in descending order by updated_at. Supports cursor-based pagination.

Input Parameters

integer
Number of results per page. Maximum is 150.
string
Cursor value for pagination to fetch the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_LIST_INTERNAL_ARTICLESFetches one page of internal articles from Intercom. Uses Intercom’s cursor-based pagination via starting_after. ONE Intercom API call is made per invocation; pagination is caller-driven via the starting_after request parameter and the next_starting_after field in the response.

Input Parameters

integer
Number of internal articles to fetch in this single call (1-200). Defaults to 25.
string
Pagination cursor for cursor-based pagination. Omit on the first call. Pass the next_starting_after value from a previous response to fetch the next page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_LIST_NEWS_ITEMSLists a page of Intercom news items. A 404 response is returned as an empty list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_LIST_SEGMENTSList segments in an Intercom workspace, optionally requesting contact counts. The response may include pagination metadata; this action retrieves one page per request.

Input Parameters

boolean
Include the count of contacts in each segment. When true, the ‘count’ field will be populated in each segment object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_LIST_SUBSCRIPTIONS_FOR_A_CONTACTYou can fetch a list of subscription types that are attached to a contact. These can be subscriptions that a user has ‘opted-in’ to or has ‘opted-out’ from, depending on the subscription type. This will return a list of Subscription Type objects that the contact is associated with. The data property will show a combined list of: 1.Opt-out subscription types that the user has opted-out from. 2.Opt-in subscription types that the user has opted-in to receiving.

Input Parameters

string
required
The unique identifier for the contact which is given by Intercom

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_LIST_SUBSCRIPTION_TYPESTool to list all subscription types available in the workspace. Use when you need to retrieve subscription configuration details including state, translations, consent type, and supported content types.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_LIST_TAGSTool to fetch all tags for the workspace. Use when you need to retrieve all available tags that can be applied to contacts, companies, and conversations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_LIST_TAGS_ATTACHED_TO_A_CONTACTList tags attached to a specific contact. The response may include pagination metadata, but this tool retrieves only one page.

Input Parameters

string
required
The unique identifier for the contact which is given by Intercom

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_LIST_TEAMSTool to retrieve all teams within a workspace. Use when you need to get a list of all available teams, their members, or assignment configurations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_LIST_TICKET_STATESTool to fetch all ticket states for the workspace. Use when you need to retrieve all configured ticket states, including both active and archived ones.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_LIST_TICKET_TYPESTool to retrieve all ticket types for the workspace. Use when you need to get all available ticket type configurations including attributes and states.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_MERGE_A_LEAD_AND_A_USERYou can merge a contact with a role of lead into a contact with a role of user.

Input Parameters

string
The unique identifier for the contact to merge away from. Must be a lead.
string
The unique identifier for the contact to merge into. Must be a user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_REDACT_CONVERSATION_CONTENTPermanently redacts the content of an Intercom conversation part.

Input Parameters

string
required
The unique identifier of the conversation containing the content
string
required
The unique identifier of the conversation part to permanently redact

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_REGISTER_FIN_VOICE_CALLTool to register a Fin Voice call with Intercom. Use when you need to create a record of an external voice call in Intercom, enabling AI-powered call analysis and customer interaction tracking.

Input Parameters

object
Additional metadata about the call as key-value pairs. Use this to store custom information about the call.
string ("five9" | "zoom_phone" | "aws_connect")
Enum for supported call sources.
string
required
External call identifier from the call provider. This is a unique identifier for the call in your system.
string
required
Phone number in E.164 format for the call (e.g., +1234567890). Must start with ’+’ followed by country code and number.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_REMOVE_SUBSCRIPTION_FROM_A_CONTACTYou can remove a specific subscription from a contact. This will return a subscription type model for the subscription type that was removed from the contact.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_REMOVE_TAG_FROM_A_CONTACTYou can remove tag from a specific contact. This will return a tag object for the tag that was removed from the contact.

Input Parameters

string
required
The unique identifier for the tag which is given by Intercom
string
required
The unique identifier for the contact which is given by Intercom

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_REOPEN_CONVERSATIONReopens a closed conversation in Intercom. Only operates correctly on conversations in a closed state; verify state via INTERCOM_GET_CONVERSATION before calling, as using on open or snoozed conversations may produce unexpected results.

Input Parameters

string
Optional message to send when reopening the conversation
string
required
ID of the admin reopening the conversation
string
required
The ID of the conversation to reopen

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_REPLY_TICKETTool to reply to a ticket with a message from admin or contact, or with a note for admins. Use when you need to add a response or comment to an existing ticket.

Input Parameters

string
required
The content of the reply. HTML is supported for notes.
string
Contact’s email address for contact replies. Used when replying as a contact.
string
External contact identifier for contact replies. Used when replying as a contact.
string
Admin identifier for admin replies. Required when replying as an admin.
string
required
The unique identifier for the ticket to reply to
integer
Unix timestamp for when the reply was created. Optional, used for contact replies.
string
required
Type of message to send. Must be ‘comment’, ‘note’, or ‘quick_reply’
array
List of URLs of attachments to include in the reply
string
Contact identifier from Intercom for contact replies. Used when replying as a contact.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_REPLY_TO_CONVERSATIONSends a reply to an existing conversation in Intercom. Always send reply before closing a conversation — never parallelize with INTERCOM_CLOSE_CONVERSATION on the same conversation. Verify conversation state via INTERCOM_GET_CONVERSATION before replying, as open/snoozed/closed states may diverge from cached values.

Input Parameters

string
required
ID of the admin sending the reply. Required - must be explicitly provided.
string
required
The message content to send as a reply
string
Type of message: comment, note, or assignment
array
List of attachment URLs to include in the reply URLs must be publicly accessible (no auth required); private or oversized URLs will cause the request to fail.
string
required
The ID of the conversation to reply to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_RETRIEVE_A_COLLECTIONYou can fetch the details of a single collection by making a GET request to https://api.intercom.io/help_center/collections/<id>.

Input Parameters

integer
required
The unique identifier for the collection which is given by Intercom.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_RETRIEVE_A_COMPANY_BY_IDYou can fetch a single company.

Input Parameters

string
required
The unique identifier for the company which is given by Intercom

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_RETRIEVE_A_HELP_CENTERFetch the details of a single Help Center by ID using a GET request to /help_center/help_centers/{id}.

Input Parameters

integer
required
The unique identifier for the collection which is given by Intercom.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_RETRIEVE_A_JOB_STATUSTool to retrieve the status of a data export job. Use when checking the progress of an export job by providing the job identifier.

Input Parameters

string
required
The unique identifier for the export job whose status you want to check.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_RETRIEVE_A_MACROTool to fetch a single macro (saved reply) by its ID. The macro will only be returned if it is visible to the authenticated user based on its visibility settings.

Input Parameters

string
required
The unique identifier for the macro to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_RETRIEVE_AN_ADMINYou can retrieve the details of a single admin.

Input Parameters

integer
required
The unique identifier of a given admin

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_RETRIEVE_AN_ARTICLEYou can fetch the details of a single article by making a GET request to https://api.intercom.io/articles/<id>.

Input Parameters

integer
required
The unique identifier for the article which is given by Intercom.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_RETRIEVE_A_SEGMENTTool to retrieve details for a single segment by its ID. Use when you need to get information about a specific segment including its name, type, and optionally the count of items.

Input Parameters

string
required
The unique identifier of the segment to retrieve.
boolean
When set to true, includes the count field showing the number of items in the segment. Only applicable for user segments.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_RETRIEVE_COMPANIESYou can fetch a single company by passing in company_id or name. https://api.intercom.io/companies?name={name} https://api.intercom.io/companies?company_id={company_id} You can fetch all companies and filter by segment_id or tag_id as a query parameter. https://api.intercom.io/companies?tag_id={tag_id} https://api.intercom.io/companies?segment_id={segment_id}

Input Parameters

string
The name of the company to filter by.
integer
The page of results to fetch. Defaults to first page
string
The tag_id of the company to filter by.
integer
How many results to display per page. Defaults to 15
string
The company_id of the company to filter by.
string
The segment_id of the company to filter by.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_RETRIEVE_INTERNAL_ARTICLETool to retrieve an internal article by ID from Intercom. Use when you need to fetch details of a specific internal article including its title, body content, and metadata.

Input Parameters

integer
required
The unique identifier for the internal article which is given by Intercom.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_RETRIEVE_NOTETool to retrieve details of a single note by its identifier. Use when you need to fetch the complete information about a specific note.

Input Parameters

string
required
The unique identifier of the note to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_RETRIEVE_TEAMTool to retrieve detailed information about a specific team by ID. Use when you need to get team details including members and assignment configuration.

Input Parameters

string
required
The unique identifier of the team to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_RETRIEVE_VISITOR_WITH_USER_IDTool to retrieve a specific visitor’s details using their user_id. Use when you need to fetch comprehensive visitor information including profile data, location, and activity metrics.

Input Parameters

string
required
A unique identifier for the visitor that you’ve assigned

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_SCROLL_OVER_ALL_COMPANIESThe list all companies functionality does not work well for huge datasets, and can result in errors and performance problems when paging deeply. The Scroll API provides an efficient mechanism for iterating over all companies in a dataset. - Each app can only have 1 scroll open at a time. You’ll get an error message if you try to have more than one open per app. You can get the first page of companies by simply sending a GET request to the scroll endpoint. For subsequent requests you will need to use the scroll parameter from the response type=“danger” name=“Scroll network timeouts”. Since scroll is often used on large datasets network errors such as timeouts can be encountered. When this occurs you will see a HTTP 500 error with the following message: “Request failed due to an internal network error. Please restart the scroll operation.” If this happens, you will need to restart your scroll query.

Input Parameters

string
Scroll Param

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_SEARCH_CONTACTSSearches Intercom contacts using query filters and operators, including filters for role, email, name, or attributes. Results support pagination and may contain nullable contact fields.

Input Parameters

string
required
Search query as a JSON string. Single filter: {“field”: “role”, “operator”: ”=”, “value”: “user”}. Multiple: {“operator”: “AND”, “value”: [filter1, filter2]}
integer
Number of results per page (1-150)
string
Cursor for pagination

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_SEARCH_CONVERSATIONSSearches for conversations using query string with support for filtering and sorting

Input Parameters

string
required
JSON object defining the Intercom search query. Example: ’{“field”: “created_at”, “operator”: ”>”, “value”: “1600000000”}’. For compound queries use: ’{“operator”: “AND”, “value”: [{“field”: “created_at”, “operator”: ”>”, “value”: “1600000000”}]}’.
integer
Number of conversations per page (1-150)
string
Field to sort by: created_at, updated_at, waiting_since
string
Sort order: ascending or descending
string
Pagination cursor - ID of the last conversation from previous page

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_SEARCH_FOR_ARTICLESYou can search for articles by making a GET request to https://api.intercom.io/articles/search.

Input Parameters

string
The state of the Articles returned. One of published, draft or all.
string
The phrase within your articles to search for.
boolean
Return a highlighted version of the matching content within your articles. Refer to the response schema for more details.
integer
The ID of the Help Center to search in.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_SEARCH_INTERNAL_ARTICLESSearches one page of internal articles in Intercom. Uses Intercom’s cursor-based pagination via starting_after. ONE Intercom API call is made per invocation; pagination is caller-driven via the starting_after request parameter and the next_starting_after field in the response. Optionally filtered by folder_id.

Input Parameters

integer
Number of internal articles to fetch in this single call (1-200). Defaults to 25.
string
The ID of the folder to search in. If not provided, searches across all folders.
string
Pagination cursor for cursor-based pagination. Omit on the first call. Pass the next_starting_after value from a previous response to fetch the next page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_SEARCH_TICKETSTool to search tickets in Intercom by filtering attribute values. Use when you need to find tickets matching specific criteria like state, creation date, assignment, or custom attributes.

Input Parameters

object
required
Query object containing filters to search tickets. Can be simple (single field/value) or complex (AND/OR with multiple filters)
object
Pagination settings for search results

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_SEND_OUTBOUND_MESSAGESends an immediate, irreversible admin-initiated in-app, email, or WhatsApp message.

Input Parameters

string
One or more Intercom contacts to copy on the message.
string
required
One contact, multiple contacts, or one phone-number recipient for WhatsApp.
string
One or more Intercom contacts to blind-copy on the message.
string
The message content. Required for in-app and email messages; WhatsApp templates do not require it. HTML and plaintext are supported.
string
Locale of the WhatsApp template, such as en.
string
The email subject. Required when message_type is email.
string
Brand identifier to send from. Intercom does not use this for WhatsApp messages.
string
The outgoing email style or WhatsApp template name. Required for email and WhatsApp messages; email styles include plain and personal.
array
WhatsApp template components and their variable values. Required for WhatsApp messages.
integer
Unix timestamp to use as the message creation time. Omit to use the current time.
string ("in_app" | "inapp" | "email" | "whatsapp")
required
The outbound channel. Intercom returns either in-app spelling as inapp.
string
required
The Intercom admin identifier to send from.
boolean
Whether to open an inbox conversation before the contact replies.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_SET_ADMIN_TO_AWAYTool to set an admin to away status in Intercom. Use when you need to mark an admin as away, optionally with a specific reason and reassignment behavior.

Input Parameters

integer
required
The unique identifier of the admin to set away
boolean
Set to “true” to change the status of the admin to away.
boolean
Set to “true” to assign any new conversation replies to your default inbox.
integer
The unique identifier of the away status reason

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_SET_AN_ADMIN_TO_AWAYYou can set an Admin as away for the Inbox.

Input Parameters

integer
required
The unique identifier of a given admin
boolean
Set to “true” to change the status of the admin to away.
boolean
Set to “true” to assign any new conversation replies to your default inbox.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_SHOW_CALLTool to retrieve a single call by ID from Intercom. Use when you need to get detailed information about a specific phone call.

Input Parameters

string
required
The unique identifier of the call to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_SHOW_CALL_TRANSCRIPTTool to get call transcript by call ID. Use when you need to retrieve the transcript text from a recorded call.

Input Parameters

string
required
The unique identifier for the call

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_SHOW_CONTACT_BY_EXTERNAL_IDTool to retrieve a contact by their external ID. Use when you need to fetch contact details using an identifier from your external system rather than Intercom’s internal ID. Only supports users, not leads.

Input Parameters

string
required
The unique identifier for the contact which is provided by the Client in their external system

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_UNARCHIVE_CONTACTTool to unarchive a previously archived contact in Intercom. Use when you need to restore an archived contact by their ID.

Input Parameters

string
required
The unique identifier for the contact to unarchive

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_UPDATE_A_COLLECTIONUpdate the details of a single collection by ID using a PUT request to /help_center/collections/{id}.

Input Parameters

integer
required
The unique identifier for the collection which is given by Intercom.
string
The name of the collection. For multilingual collections, this will be the name of the default language”s content.
string
The id of the parent collection. If null then it will be updated as the first level collection.
string
The description of the collection. For multilingual collections, this will be the description of the default language”s content.
string ("None" | "group_translated_content")
The type of object - group_translated_content.
string
The name of the collection or section.
string ("None" | "group_content")
The type of object - group_content .
string
The name of the collection or section.
string ("None" | "group_content")
The type of object - group_content .
string
The name of the collection or section.
string ("None" | "group_content")
The type of object - group_content .
string
The name of the collection or section.
string ("None" | "group_content")
The type of object - group_content .
string
The name of the collection or section.
string ("None" | "group_content")
The type of object - group_content .
string
The name of the collection or section.
string ("None" | "group_content")
The type of object - group_content .
string
The name of the collection or section.
string ("None" | "group_content")
The type of object - group_content .
string
The name of the collection or section.
string ("None" | "group_content")
The type of object - group_content .
string
The name of the collection or section.
string ("None" | "group_content")
The type of object - group_content .
string
The name of the collection or section.
string ("None" | "group_content")
The type of object - group_content .
string
The name of the collection or section.
string ("None" | "group_content")
The type of object - group_content .
string
The name of the collection or section.
string ("None" | "group_content")
The type of object - group_content .
string
The name of the collection or section.
string ("None" | "group_content")
The type of object - group_content .
string
The name of the collection or section.
string ("None" | "group_content")
The type of object - group_content .
string
The name of the collection or section.
string ("None" | "group_content")
The type of object - group_content .
string
The name of the collection or section.
string ("None" | "group_content")
The type of object - group_content .
string
The name of the collection or section.
string ("None" | "group_content")
The type of object - group_content .
string
The name of the collection or section.
string ("None" | "group_content")
The type of object - group_content .
string
The name of the collection or section.
string ("None" | "group_content")
The type of object - group_content .
string
The name of the collection or section.
string ("None" | "group_content")
The type of object - group_content .
string
The name of the collection or section.
string ("None" | "group_content")
The type of object - group_content .
string
The name of the collection or section.
string ("None" | "group_content")
The type of object - group_content .
string
The name of the collection or section.
string ("None" | "group_content")
The type of object - group_content .
string
The name of the collection or section.
string ("None" | "group_content")
The type of object - group_content .
string
The name of the collection or section.
string ("None" | "group_content")
The type of object - group_content .
string
The name of the collection or section.
string ("None" | "group_content")
The type of object - group_content .
string
The name of the collection or section.
string ("None" | "group_content")
The type of object - group_content .
string
The name of the collection or section.
string ("None" | "group_content")
The type of object - group_content .
string
The name of the collection or section.
string ("None" | "group_content")
The type of object - group_content .
string
The name of the collection or section.
string ("None" | "group_content")
The type of object - group_content .
string
The name of the collection or section.
string ("None" | "group_content")
The type of object - group_content .
string
The name of the collection or section.
string ("None" | "group_content")
The type of object - group_content .
string
The name of the collection or section.
string ("None" | "group_content")
The type of object - group_content .
string
The name of the collection or section.
string ("None" | "group_content")
The type of object - group_content .
string
The name of the collection or section.
string ("None" | "group_content")
The type of object - group_content .
string
The name of the collection or section.
string ("None" | "group_content")
The type of object - group_content .
string
The name of the collection or section.
string ("None" | "group_content")
The type of object - group_content .
string
The description of the collection. Only available for collections.
string
The description of the collection. Only available for collections.
string
The description of the collection. Only available for collections.
string
The description of the collection. Only available for collections.
string
The description of the collection. Only available for collections.
string
The description of the collection. Only available for collections.
string
The description of the collection. Only available for collections.
string
The description of the collection. Only available for collections.
string
The description of the collection. Only available for collections.
string
The description of the collection. Only available for collections.
string
The description of the collection. Only available for collections.
string
The description of the collection. Only available for collections.
string
The description of the collection. Only available for collections.
string
The description of the collection. Only available for collections.
string
The description of the collection. Only available for collections.
string
The description of the collection. Only available for collections.
string
The description of the collection. Only available for collections.
string
The description of the collection. Only available for collections.
string
The description of the collection. Only available for collections.
string
The description of the collection. Only available for collections.
string
The description of the collection. Only available for collections.
string
The description of the collection. Only available for collections.
string
The description of the collection. Only available for collections.
string
The description of the collection. Only available for collections.
string
The description of the collection. Only available for collections.
string
The description of the collection. Only available for collections.
string
The description of the collection. Only available for collections.
string
The description of the collection. Only available for collections.
string
The description of the collection. Only available for collections.
string
The description of the collection. Only available for collections.
string
The description of the collection. Only available for collections.
string
The description of the collection. Only available for collections.
string
The description of the collection. Only available for collections.
string
The description of the collection. Only available for collections.
string
The description of the collection. Only available for collections.
string
The description of the collection. Only available for collections.
string
The description of the collection. Only available for collections.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_UPDATE_A_COMPANYYou can update a single company using the Intercom provisioned id. {% admonition type=“attention” name=“Using company_id” %} When updating a company it is not possible to update company_id. This can only be set once upon creation of the company. {% /admonition %}

Input Parameters

string
required
The unique identifier for the company which is given by Intercom
string
The name of the Company
string
The name of the plan you have associated with the company.
integer
The number of employees in this company.
string
The URL for this company’s website. Please note that the value specified here is not validated. Accepts any string.
string
The industry that this company operates in.
integer
How much revenue the company generates for your business. Note that this will truncate floats. i.e. it only allows whole integers, 155.98 will be truncated to 155. Note that this has an upper limit of 2**31-1 or 2147483647.
object
User-defined key-value pairs for custom company data. Keys must be pre-defined via the Data Attributes API. Field names must not contain periods or dollar signs, max 190 characters. Values: strings (max 255 chars), numbers, or booleans. Max 100 fields.
integer
The time the company was created by you as a Unix timestamp.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_UPDATE_A_CONTACTUpdate an existing contact (user or lead). Optionally attach companies after the update; attachment outcomes are reported in the execution message.

Input Parameters

string
required
The unique identifier for the contact which is given by Intercom.
string
The contact’s name.
string
The role of the contact. Can be ‘user’ or ‘lead’.
string
The contact’s email address.
string
The contact’s phone number.
string
An image URL containing the avatar of a contact.
integer
The id of an admin that has been assigned account ownership of the contact.
array
List of companies to attach to the contact. Each company object must contain either ‘id’ (Intercom company ID) or ‘company_id’ (client-provided company ID). Company attachments are made via separate API calls after updating the contact.
string
A unique identifier for the contact which is provided by the client.
integer
The time when the contact was last seen as a UNIX timestamp.
integer
The time specified for when a contact signed up as a UNIX timestamp.
object
The custom attributes which are set for the contact as key-value pairs.
boolean
Whether the contact is unsubscribed from emails.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_UPDATE_AN_ARTICLEYou can update the details of a single article by making a PUT request to https://api.intercom.io/articles/<id>.

Input Parameters

integer
required
The unique identifier for the article which is given by Intercom.
string
The content of the article. For multilingual articles, this will be the body of the default language”s content.
string ("published" | "draft")
Whether the article will be published or will be a draft. Defaults to draft. For multilingual articles, this will be the state of the default language”s content.
string
The title of the article.For multilingual articles, this will be the title of the default language”s content.
integer
The id of the author of the article. For multilingual articles, this will be the id of the author of the default language”s content. Must be a teammate on the help center”s workspace.
string
The id of the article”s parent collection or section. An article without this field stands alone.
string
The description of the article. For multilingual articles, this will be the description of the default language”s content.
string
The type of parent, which can either be a collection or section.
string ("None" | "article_translated_content")
The type of object - article_translated_content.
string
The URL of the article.
string
The URL of the article.
string
The URL of the article.
string
The URL of the article.
string
The URL of the article.
string
The URL of the article.
string
The URL of the article.
string
The URL of the article.
string
The URL of the article.
string
The URL of the article.
string
The URL of the article.
string
The URL of the article.
string
The URL of the article.
string
The URL of the article.
string
The URL of the article.
string
The URL of the article.
string
The URL of the article.
string
The URL of the article.
string
The URL of the article.
string
The URL of the article.
string
The URL of the article.
string
The URL of the article.
string
The URL of the article.
string
The URL of the article.
string
The URL of the article.
string
The URL of the article.
string
The URL of the article.
string
The URL of the article.
string
The URL of the article.
string
The URL of the article.
string
The URL of the article.
string
The URL of the article.
string
The URL of the article.
string
The URL of the article.
string
The body of the article.
string ("None" | "article_content")
The type of object - article_content .
string
The body of the article.
string ("None" | "article_content")
The type of object - article_content .
string
The body of the article.
string ("None" | "article_content")
The type of object - article_content .
string
The body of the article.
string ("None" | "article_content")
The type of object - article_content .
string
The body of the article.
string ("None" | "article_content")
The type of object - article_content .
string
The body of the article.
string ("None" | "article_content")
The type of object - article_content .
string
The body of the article.
string ("None" | "article_content")
The type of object - article_content .
string
The body of the article.
string ("None" | "article_content")
The type of object - article_content .
string
The body of the article.
string ("None" | "article_content")
The type of object - article_content .
string
The body of the article.
string ("None" | "article_content")
The type of object - article_content .
string
The body of the article.
string ("None" | "article_content")
The type of object - article_content .
string
The body of the article.
string ("None" | "article_content")
The type of object - article_content .
string
The body of the article.
string ("None" | "article_content")
The type of object - article_content .
string
The body of the article.
string ("None" | "article_content")
The type of object - article_content .
string
The body of the article.
string ("None" | "article_content")
The type of object - article_content .
string
The body of the article.
string ("None" | "article_content")
The type of object - article_content .
string
The body of the article.
string ("None" | "article_content")
The type of object - article_content .
string
The body of the article.
string ("None" | "article_content")
The type of object - article_content .
string
The body of the article.
string ("None" | "article_content")
The type of object - article_content .
string
The body of the article.
string ("None" | "article_content")
The type of object - article_content .
string
The body of the article.
string ("None" | "article_content")
The type of object - article_content .
string
The body of the article.
string ("None" | "article_content")
The type of object - article_content .
string
The body of the article.
string ("None" | "article_content")
The type of object - article_content .
string
The body of the article.
string ("None" | "article_content")
The type of object - article_content .
string
The body of the article.
string ("None" | "article_content")
The type of object - article_content .
string
The body of the article.
string ("None" | "article_content")
The type of object - article_content .
string
The body of the article.
string ("None" | "article_content")
The type of object - article_content .
string
The body of the article.
string ("None" | "article_content")
The type of object - article_content .
string
The body of the article.
string ("None" | "article_content")
The type of object - article_content .
string
The body of the article.
string ("None" | "article_content")
The type of object - article_content .
string
The body of the article.
string ("None" | "article_content")
The type of object - article_content .
string
The body of the article.
string ("None" | "article_content")
The type of object - article_content .
string
The body of the article.
string ("None" | "article_content")
The type of object - article_content .
string
The body of the article.
string ("None" | "article_content")
The type of object - article_content .
string ("published" | "draft")
Whether the article is published or is a draft .
string
The title of the article.
string ("published" | "draft")
Whether the article is published or is a draft .
string
The title of the article.
string ("published" | "draft")
Whether the article is published or is a draft .
string
The title of the article.
string ("published" | "draft")
Whether the article is published or is a draft .
string
The title of the article.
string ("published" | "draft")
Whether the article is published or is a draft .
string
The title of the article.
string ("published" | "draft")
Whether the article is published or is a draft .
string
The title of the article.
string ("published" | "draft")
Whether the article is published or is a draft .
string
The title of the article.
string ("published" | "draft")
Whether the article is published or is a draft .
string
The title of the article.
string ("published" | "draft")
Whether the article is published or is a draft .
string
The title of the article.
string ("published" | "draft")
Whether the article is published or is a draft .
string
The title of the article.
string ("published" | "draft")
Whether the article is published or is a draft .
string
The title of the article.
string ("published" | "draft")
Whether the article is published or is a draft .
string
The title of the article.
string ("published" | "draft")
Whether the article is published or is a draft .
string
The title of the article.
string ("published" | "draft")
Whether the article is published or is a draft .
string
The title of the article.
string ("published" | "draft")
Whether the article is published or is a draft .
string
The title of the article.
string ("published" | "draft")
Whether the article is published or is a draft .
string
The title of the article.
string ("published" | "draft")
Whether the article is published or is a draft .
string
The title of the article.
string ("published" | "draft")
Whether the article is published or is a draft .
string
The title of the article.
string ("published" | "draft")
Whether the article is published or is a draft .
string
The title of the article.
string ("published" | "draft")
Whether the article is published or is a draft .
string
The title of the article.
string ("published" | "draft")
Whether the article is published or is a draft .
string
The title of the article.
string ("published" | "draft")
Whether the article is published or is a draft .
string
The title of the article.
string ("published" | "draft")
Whether the article is published or is a draft .
string
The title of the article.
string ("published" | "draft")
Whether the article is published or is a draft .
string
The title of the article.
string ("published" | "draft")
Whether the article is published or is a draft .
string
The title of the article.
string ("published" | "draft")
Whether the article is published or is a draft .
string
The title of the article.
string ("published" | "draft")
Whether the article is published or is a draft .
string
The title of the article.
string ("published" | "draft")
Whether the article is published or is a draft .
string
The title of the article.
string ("published" | "draft")
Whether the article is published or is a draft .
string
The title of the article.
string ("published" | "draft")
Whether the article is published or is a draft .
string
The title of the article.
string ("published" | "draft")
Whether the article is published or is a draft .
string
The title of the article.
string ("published" | "draft")
Whether the article is published or is a draft .
string
The title of the article.
string ("published" | "draft")
Whether the article is published or is a draft .
string
The title of the article.
string ("published" | "draft")
Whether the article is published or is a draft .
string
The title of the article.
string
The URL of the article.
string
The URL of the article.
string
The URL of the article.
string
The body of the article.
string ("None" | "article_content")
The type of object - article_content .
string
The body of the article.
string ("None" | "article_content")
The type of object - article_content .
string
The body of the article.
string ("None" | "article_content")
The type of object - article_content .
string ("published" | "draft")
Whether the article is published or is a draft .
string
The title of the article.
string ("published" | "draft")
Whether the article is published or is a draft .
string
The title of the article.
string ("published" | "draft")
Whether the article is published or is a draft .
string
The title of the article.
integer
The ID of the author of the article.
integer
The ID of the author of the article.
integer
The ID of the author of the article.
integer
The ID of the author of the article.
integer
The ID of the author of the article.
integer
The ID of the author of the article.
integer
The ID of the author of the article.
integer
The ID of the author of the article.
integer
The ID of the author of the article.
integer
The ID of the author of the article.
integer
The ID of the author of the article.
integer
The ID of the author of the article.
integer
The ID of the author of the article.
integer
The ID of the author of the article.
integer
The ID of the author of the article.
integer
The ID of the author of the article.
integer
The ID of the author of the article.
integer
The ID of the author of the article.
integer
The ID of the author of the article.
integer
The ID of the author of the article.
integer
The ID of the author of the article.
integer
The ID of the author of the article.
integer
The ID of the author of the article.
integer
The ID of the author of the article.
integer
The ID of the author of the article.
integer
The ID of the author of the article.
integer
The ID of the author of the article.
integer
The ID of the author of the article.
integer
The ID of the author of the article.
integer
The ID of the author of the article.
integer
The ID of the author of the article.
integer
The ID of the author of the article.
integer
The ID of the author of the article.
integer
The ID of the author of the article.
integer
The time when the article was created (seconds).
string
The description of the article.
integer
The time when the article was last updated (seconds).
integer
The time when the article was created (seconds).
string
The description of the article.
integer
The time when the article was last updated (seconds).
integer
The time when the article was created (seconds).
string
The description of the article.
integer
The time when the article was last updated (seconds).
integer
The time when the article was created (seconds).
string
The description of the article.
integer
The time when the article was last updated (seconds).
integer
The time when the article was created (seconds).
string
The description of the article.
integer
The time when the article was last updated (seconds).
integer
The time when the article was created (seconds).
string
The description of the article.
integer
The time when the article was last updated (seconds).
integer
The time when the article was created (seconds).
string
The description of the article.
integer
The time when the article was last updated (seconds).
integer
The time when the article was created (seconds).
string
The description of the article.
integer
The time when the article was last updated (seconds).
integer
The time when the article was created (seconds).
string
The description of the article.
integer
The time when the article was last updated (seconds).
integer
The time when the article was created (seconds).
string
The description of the article.
integer
The time when the article was last updated (seconds).
integer
The time when the article was created (seconds).
string
The description of the article.
integer
The time when the article was last updated (seconds).
integer
The time when the article was created (seconds).
string
The description of the article.
integer
The time when the article was last updated (seconds).
integer
The time when the article was created (seconds).
string
The description of the article.
integer
The time when the article was last updated (seconds).
integer
The time when the article was created (seconds).
string
The description of the article.
integer
The time when the article was last updated (seconds).
integer
The time when the article was created (seconds).
string
The description of the article.
integer
The time when the article was last updated (seconds).
integer
The time when the article was created (seconds).
string
The description of the article.
integer
The time when the article was last updated (seconds).
integer
The time when the article was created (seconds).
string
The description of the article.
integer
The time when the article was last updated (seconds).
integer
The time when the article was created (seconds).
string
The description of the article.
integer
The time when the article was last updated (seconds).
integer
The time when the article was created (seconds).
string
The description of the article.
integer
The time when the article was last updated (seconds).
integer
The time when the article was created (seconds).
string
The description of the article.
integer
The time when the article was last updated (seconds).
integer
The time when the article was created (seconds).
string
The description of the article.
integer
The time when the article was last updated (seconds).
integer
The time when the article was created (seconds).
string
The description of the article.
integer
The time when the article was last updated (seconds).
integer
The time when the article was created (seconds).
string
The description of the article.
integer
The time when the article was last updated (seconds).
integer
The time when the article was created (seconds).
string
The description of the article.
integer
The time when the article was last updated (seconds).
integer
The time when the article was created (seconds).
string
The description of the article.
integer
The time when the article was last updated (seconds).
integer
The time when the article was created (seconds).
string
The description of the article.
integer
The time when the article was last updated (seconds).
integer
The time when the article was created (seconds).
string
The description of the article.
integer
The time when the article was last updated (seconds).
integer
The time when the article was created (seconds).
string
The description of the article.
integer
The time when the article was last updated (seconds).
integer
The time when the article was created (seconds).
string
The description of the article.
integer
The time when the article was last updated (seconds).
integer
The time when the article was created (seconds).
string
The description of the article.
integer
The time when the article was last updated (seconds).
integer
The time when the article was created (seconds).
string
The description of the article.
integer
The time when the article was last updated (seconds).
integer
The time when the article was created (seconds).
string
The description of the article.
integer
The time when the article was last updated (seconds).
integer
The time when the article was created (seconds).
string
The description of the article.
integer
The time when the article was last updated (seconds).
integer
The time when the article was created (seconds).
string
The description of the article.
integer
The time when the article was last updated (seconds).
integer
The ID of the author of the article.
integer
The ID of the author of the article.
integer
The ID of the author of the article.
integer
The time when the article was created (seconds).
string
The description of the article.
integer
The time when the article was last updated (seconds).
integer
The time when the article was created (seconds).
string
The description of the article.
integer
The time when the article was last updated (seconds).
integer
The time when the article was created (seconds).
string
The description of the article.
integer
The time when the article was last updated (seconds).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_UPDATE_CONTACTTool to update an existing contact in Intercom. Use when you need to modify contact information such as name, email, custom attributes, or other properties.

Input Parameters

string
Contact’s full name
string
The contact’s role designation (user/lead)
string
The contact’s email address
string
Contact phone number (E.164 format recommended, e.g., +353871234567)
string
Image URL for the contact’s avatar
integer
Admin ID assigned as account owner
string
required
The unique identifier for the contact to update
string
A unique identifier from your system
integer
Unix timestamp of last activity
integer
Unix timestamp of signup date
object
Custom key-value data fields
boolean
Email subscription status

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_UPDATE_CONTENT_IMPORT_SOURCETool to update an existing content import source in Fin Content Library. Use when you need to modify the URL, sync behavior, or status of an existing content import source.

Input Parameters

string
required
The URL of the content import source. Must be a valid URL.
string
The operational state of the source. Allowed values: ‘active’, ‘deactivated’. Defaults to ‘active’.
string
required
The unique identifier for the content import source which is given by Intercom.
string
required
Controls how the source is synchronized. Via API, the only allowed value is ‘api’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_UPDATE_CONVERSATIONUpdate conversation metadata without performing reply or state actions.

Input Parameters

boolean
Whether the conversation is marked as read.
string
The new title for the conversation.
string
The Intercom company ID to associate, or null to remove the current company association. Omit this field to leave the association unchanged.
string
Return message body and subject fields as plaintext.
string
required
The ID of the conversation to update.
object
Conversation custom attributes to set, as key-value pairs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_UPDATE_DATA_ATTRIBUTEUpdate an existing Intercom data attribute’s description, archive status, Messenger writability, or predefined options. Changing the attribute’s type is not supported by this tool.

Input Parameters

array
Predefined value options (required for list-type attributes). Each object contains a ‘value’ property
boolean
Whether to archive the attribute
string
Human-readable description for UI display
integer
required
The unique identifier of the data attribute to update
boolean
Whether the Messenger can update this attribute

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_UPDATE_EXTERNAL_PAGETool to update an existing external page in Fin Content Library. Use when you need to modify the content, metadata, or availability settings of an external page. Only pages created through the API can be updated.

Input Parameters

string
required
The page URL; used by Fin to attribute answers to sources. Must be a valid URL. Required for updates.
string
required
The body content of the external page in HTML format. Required for updates.
string
required
The title of the external page. Required for updates.
string
required
Language identifier code. Must be ‘en’. Required for updates.
string
required
The unique identifier for the external page provided by Intercom
integer
required
Identifier for the content import source. This links the page to a specific content import source in your workspace. Required for updates.
string
required
The identifier for the external page which was given by the source. Required for updates.
boolean
Whether the external page should be used to answer questions by Fin. Defaults to true if not provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_UPDATE_INTERNAL_ARTICLEUpdates an existing Intercom internal article by ID, supplying its title, body, author and owner information.

Input Parameters

string
required
The article content in HTML format.
string
required
The article heading.
integer
required
The id of the owner of the article.
integer
required
The id of the author of the article.
integer
required
The unique identifier for the internal article which is given by Intercom.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_UPDATE_TICKETTool to update an existing ticket in Intercom. Use when you need to modify ticket attributes, state, assignment, or other properties.

Input Parameters

boolean
Controls ticket open status; setting to false closes and unsnoozes the ticket
integer
The ID of the admin performing ticket update, needed for workflows
boolean
Specifies visibility to users
string
required
The unique identifier for the ticket assigned by Intercom
string
ID of the company linked to the ticket; set to empty string to remove company association
string
ID of admin or team for assignment; set to ‘0’ to unassign
integer
Unix timestamp for when ticket should reopen
string
ID of the ticket state associated with the ticket type
object
An object containing key-value pairs for ticket attributes (e.g., default_title, default_description)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_UPDATE_TICKET_TYPETool to update an existing ticket type in the workspace. Use when you need to modify a ticket type’s name, description, category, icon, or archive status.

Input Parameters

string
An emoji icon (copy from Twemoji Cheatsheet).
string
The ticket type’s name.
boolean
Archived status of the ticket type.
string
One of: Customer, Back-office, or Tracker.
string
The ticket type’s description.
boolean
Whether tickets are internal-only or shared with customers.
string
required
The unique identifier of the ticket type to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTERCOM_UPDATE_TICKET_TYPE_ATTRIBUTETool to update an existing attribute for a ticket type. Use when you need to modify properties like description, visibility, or requirements for a ticket type attribute.

Input Parameters

string
The label for the ticket type attribute
boolean
Enables multiple text lines for string-type attributes
string
A comma delimited list of items for the attribute value (only applicable to list attributes)
string
The description of the attribute presented to the teammate or contact
string
required
The unique identifier of the ticket type attribute to update
string
required
The unique identifier of the ticket type
boolean
Whether this field displays to teammates during ticket creation
boolean
Whether teammates must complete this field when creating tickets
boolean
Whether this field displays to contacts during ticket creation
boolean
Permits multiple file attachments for file-type attributes
boolean
Whether contacts must complete this field when creating tickets

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not