IntercomApi

The IntercomApi MCP Server offers a comprehensive suite of tools for managing and interacting with the Intercom platform.

Available Tools

Intercom API Subdomain

The IntercomApi MCP Server requires setting the INTERCOM_API_SUBDOMAIN secret in the Arcade Dashboard. The appropriate value depends on the region you are using:

• For the United States servers, set INTERCOM_API_SUBDOMAIN secret to api
• For the European servers, set INTERCOM_API_SUBDOMAIN secret to api.eu
• For the Australian servers, set INTERCOM_API_SUBDOMAIN secret to api.au

IntercomApi.GetCurrentAdminInfo

Retrieve details of the currently authorized Intercom admin.

Parameters

This tool does not take any parameters. Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN. Check which value to use for the secret. Learn how to configure secrets.

IntercomApi.SetAdminAway

Mark an admin as away in the Intercom Inbox.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• admin_id (integer, optional) The unique identifier for the admin to set as away in the Intercom Inbox. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN. Check which value to use for the secret. Learn how to configure secrets.

IntercomApi.GetAdminActivityLogs

Retrieve a log of activities by all admins in an app.

Parameters

• start_date_unix_timestamp (string, required) The start date for requested data, formatted as a UNIX timestamp.
• end_date_unix_timestamp (string, optional) The end date for data retrieval in UNIX timestamp format. Determines the latest logs to include.

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.FetchWorkspaceAdmins

Retrieve a list of admins in a workspace.

Parameters

This tool does not take any parameters. Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.RetrieveAdminDetails

Retrieve details of a specific admin from Intercom.

Parameters

• admin_id (integer, required) The unique identifier for the admin. Provide an integer value to retrieve the admin’s details.

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.ListRecentArticles

Fetches a list of all articles from Intercom.

Parameters

This tool does not take any parameters. Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.CreateIntercomArticle

Create a new article in Intercom.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.FetchIntercomArticle

Fetch details of a specific Intercom article by ID.

Parameters

• article_id (integer, required) The unique identifier for the article provided by Intercom. Use this to fetch article details.

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.UpdateArticleDetails

Update details of a specific article on Intercom.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• article_identifier (integer, optional) The unique identifier for the article on Intercom. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.DeleteIntercomArticle

Deletes a specified article in Intercom.

Parameters

• article_id (integer, required) The unique identifier for the article to be deleted, provided by Intercom.

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.ListCollections

Retrieve a list of all collections sorted by update date.

Parameters

This tool does not take any parameters. Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.CreateHelpCenterCollection

Create a new collection in the Intercom Help Center.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.FetchIntercomCollectionDetails

Fetches details of a specific Intercom collection.

Parameters

• collection_id (integer, required) The unique identifier for the collection provided by Intercom. It is required to fetch a specific collection’s details.

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.UpdateCollectionDetails

Update the details of a single collection.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• collection_id (integer, optional) The unique identifier for the collection in Intercom. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.DeleteCollection

Delete a specified collection in Intercom.

Parameters

• collection_id (integer, required) The unique identifier for the collection provided by Intercom, required to delete it.

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.GetHelpCenterDetails

Retrieve detailed information about a specific Help Center.

Parameters

• help_center_id (integer, required) The unique identifier for the Help Center collection provided by Intercom.

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.ListHelpCenters

Retrieve a list of all Help Centers from Intercom.

Parameters

This tool does not take any parameters. Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.GetRecentHelpCenterSections

Fetches a list of all help center sections sorted by recent updates.

Parameters

This tool does not take any parameters. Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.CreateHelpCenterSection

Create a new section in the help center.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.GetSectionDetails

Fetch details of a specific help center section by ID.

Parameters

• section_id (integer, required) The unique identifier for the help center section provided by Intercom.

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.UpdateHelpCenterSection

Update the details of a help center section.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• section_id (integer, optional) The unique identifier for the section assigned by Intercom. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.DeleteIntercomSection

Delete a section from Intercom Help Center.

Parameters

• section_id (integer, required) The unique identifier for the section to be deleted from Intercom. Provided by Intercom.

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.CreateOrUpdateCompany

Create or update a company in Intercom.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.FetchCompanyDetails

Fetch detailed information about a single company.

Parameters

• company_id (string, optional) The unique identifier for the company to retrieve details for.
• company_name (string, optional) The exact name of the company to filter and retrieve details for.
• company_segment_id (string, optional) The segment ID to filter companies by. Use this to retrieve companies associated with a specific segment.
• company_tag_id (string, optional) The tag ID used to filter and retrieve specific companies by their associated tag.
• result_page_number (integer, optional) The page number of results to fetch. Defaults to the first page.
• results_per_page (integer, optional) Number of results to display per page. Defaults to 15.

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.GetCompanyDetails

Retrieve detailed information about a specific company.

Parameters

• company_id (string, required) The unique identifier for the company provided by Intercom.

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.UpdateCompanyInfo

Update company information by ID in Intercom.

Parameters

• company_identifier (string, required) The unique identifier assigned by Intercom for the company. Required to update company details.

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.DeleteCompany

Deletes a single company by its ID.

Parameters

• company_id (string, required) The unique identifier for the company to be deleted in Intercom.

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.FetchCompanyContacts

Fetch a list of contacts for a specific company.

Parameters

• company_id (string, required) The unique identifier for the company, provided by Intercom, to fetch associated contacts.

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.ListCompanySegments

Fetch segments belonging to a specific company.

Parameters

• company_id (string, required) The unique identifier for the company provided by Intercom.

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.ListCompaniesIntercom

Retrieve a sorted list of companies from Intercom.

Parameters

• page_number (integer, optional) The page number of results to retrieve, starting from the first page by default.
• results_per_page (integer, optional) Number of results to return per page. The default is 15.
• sort_order (string, optional) Specify ‘asc’ for ascending or ‘desc’ for descending order when listing companies. Defaults to ‘desc’.

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.ScrollThroughAllCompanies

Efficiently iterate over all companies using the scroll API.

Parameters

• scroll_page_identifier (string, optional) The paging identifier returned in the response to continue fetching the next set of companies. Use the initial API response for the first request and subsequent responses for the next requests.

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.AttachCompanyToContact

Attach a company to a single contact in Intercom.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• contact_unique_identifier (string, optional) The unique identifier for the contact as provided by Intercom. This is required to attach a company to the specified contact. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.FetchContactCompanies

Fetches a list of companies associated with a contact.

Parameters

• contact_identifier (string, required) The unique identifier for the contact provided by Intercom, required to fetch associated companies.

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.DetachCompanyFromContact

Detach a company from a specified contact in Intercom.

Parameters

• company_id (string, required) The unique identifier for the company provided by Intercom.
• contact_identifier (string, required) The unique identifier for the contact provided by Intercom.

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.FetchContactNotes

Fetches notes associated with a specific contact.

Parameters

• contact_id (integer, required) The unique ID of the contact whose notes you want to fetch.

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.AddNoteToContact

Add a note to a contact in Intercom.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• contact_id (integer, optional) The unique identifier for the contact to whom the note will be added. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.GetContactSegments

Fetch segments associated with a contact.

Parameters

• contact_unique_identifier (string, required) The unique identifier for the contact provided by Intercom. This is required to fetch associated segments.

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.ListContactSubscriptions

Retrieve subscription types associated with a contact.

Parameters

• contact_identifier (string, required) The unique identifier provided by Intercom for the contact.

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.ManageContactSubscription

Manage a contact’s subscription preferences in Intercom.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• contact_identifier (string, optional) The unique identifier assigned to the contact by Intercom. This is required to specify which contact you want to manage the subscription for. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.RemoveSubscriptionFromContact

Remove a specific subscription from a contact.

Parameters

• contact_identifier (string, required) The unique identifier for the contact in Intercom. Required to specify which contact’s subscription should be removed.
• subscription_type_id (string, required) The unique identifier for the subscription type to remove from a contact in Intercom.

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.GetContactTags

Fetches tags attached to a specific contact.

Parameters

• contact_unique_identifier (string, required) The unique identifier for the contact, provided by Intercom, used to fetch associated tags.

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.TagContact

Attach a tag to a specific contact.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• contact_id (string, optional) The unique identifier for the contact in Intercom. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.RemoveTagFromContact

Remove a tag from a specific contact.

Parameters

• contact_id (string, required) The unique identifier for the contact in Intercom. This ID is necessary to specify which contact to remove the tag from.
• tag_identifier (string, required) The unique identifier for the tag assigned by Intercom. Used to specify which tag to remove from a contact.

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.UpdateIntercomContact

Update an existing Intercom contact’s details.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• contact_id (string, optional) The unique identifier of the contact to update in Intercom. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.FetchContactDetails

Fetch the details of a specific contact.

Parameters

• contact_id (string, required) The unique identifier of the contact you want to fetch details for.

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.DeleteContact

Deletes a specified contact from the system.

Parameters

• contact_id (string, required) The unique identifier of the contact to be deleted.

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.MergeContactIntercom

Merge a lead contact into a user contact in Intercom.

Parameters

• lead_contact_id (string, optional) The unique identifier of the contact to merge away from. It must be a lead.
• merge_into_user_id (string, optional) Unique identifier for the contact to merge into. Must be a user contact ID.

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.SearchIntercomContacts

Search for contacts by their attributes.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.FetchAllContacts

Fetch a list of all contacts in your workspace.

Parameters

This tool does not take any parameters. Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.CreateNewContact

Create a new contact in the Intercom system.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.ArchiveContact

Archive a single contact in Intercom.

Parameters

• contact_id (string, required) The unique identifier of the contact to be archived in Intercom.

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.UnarchiveContact

Unarchive a single contact in Intercom.

Parameters

• contact_id (string, required) The unique identifier of the contact to unarchive in Intercom.

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.TagConversation

Attach a tag to a specific conversation.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• conversation_id (string, optional) The unique identifier of the conversation to which a tag will be attached. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.RemoveTagFromConversation

Remove a tag from a specific conversation.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• conversation_id (string, optional) The unique identifier of the conversation from which the tag will be removed. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• tag_id (string, optional) The unique identifier of the tag to be removed from the conversation. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.FetchConversationList

Retrieve a list of conversations with optional pagination options.

Parameters

• pagination_starting_cursor (string, optional) Cursor string to fetch the next page of conversations for pagination.
• results_per_page (integer, optional) Number of conversation results to display per page. Default is 20 if not specified.

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.CreateContactConversation

Create a conversation initiated by a contact.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.GetConversationDetails

Fetch details of a specific conversation from Intercom.

Parameters

• conversation_id (integer, required) The ID of the conversation to retrieve details for. This is required to fetch the specific conversation data.
• retrieve_plaintext_conversation (string, optional) Set to ‘plaintext’ to retrieve conversation messages in plain text format.

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.UpdateConversation

Update an existing conversation.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• conversation_id (integer, optional) The ID of the conversation to update. It should be an integer representing the conversation you want to modify. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• retrieve_messages_as_plaintext (string, optional) Specify ‘plaintext’ to retrieve conversation messages in plain text format. Only used when mode is ‘execute’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.SearchConversations

Search conversations by specific attributes.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.ReplyToIntercomConversation

Reply to a conversation in Intercom with a message or note.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• conversation_identifier (string, optional) The unique identifier for the conversation or ‘last’ to reply to the most recent conversation. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.ManageConversation

Manage and update conversation statuses or assignments.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• conversation_id (string, optional) The unique identifier for the conversation in Intercom. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.AutoAssignIntercomConversation

Auto-assign a conversation in Intercom.

Parameters

• conversation_id (string, required) The unique identifier for the conversation provided by Intercom.

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.AttachContactToConversation

Attach a contact to a conversation in Intercom.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• conversation_id (string, optional) The unique identifier for the conversation in Intercom. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.DetachContactFromConversation

Detach a contact from a conversation in Intercom.

Parameters

• contact_identifier (string, required) The unique identifier for the contact provided by Intercom. Use this to specify which contact to detach from the conversation.
• conversation_identifier (string, required) The unique identifier for the conversation in Intercom. This is required to detach the contact from the specified conversation.
• admin_id (json, optional) The ID of the admin performing the detachment action.

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.RedactConversationPartOrMessage

Redact specific parts or messages within a conversation.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.ListWorkspaceDataAttributes

Fetch data attributes for contacts, companies, or conversations.

Parameters

• data_attribute_model (string, optional) Specify the model type: ‘contact’, ‘company’, or ‘conversation’.
• include_archived_attributes (boolean, optional) Set to true to include archived attributes in the list. By default, archived attributes are excluded.

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.CreateDataAttribute

Create a data attribute for a contact or company.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.UpdateDataAttribute

Update a data attribute’s value via the API.

Parameters

• data_attribute_id (integer, required) The unique identifier for the data attribute to be updated.
• allow_messenger_updates (boolean, optional) Specify if the data attribute can be updated by the Messenger. Use ‘true’ to allow updates and ‘false’ to prevent them.
• archive_attribute (boolean, optional) Indicate if the attribute should be archived. True to archive, False to keep unarchived.
• attribute_description (string, optional) The readable description for the attribute as seen in the UI. Provides context or additional information about the attribute.
• list_attribute_options (array[string], optional) An array of strings representing options for list attributes. Each option should be provided as a hash with value as the key and the data type must be string.

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.SendIntercomEvent

Submit events to Intercom for user activity tracking.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.CreateEventSummaries

Create event summaries for tracking user events.

Parameters

• event_last_occurrence (integer, optional) The timestamp representing the last occurrence of the event.
• event_name_for_summaries (string, optional) The name of the event, typically a past-tense verb-noun combination like ‘updated-plan’.
• event_occurrence_count (integer, optional) The number of times the event occurred for the specified user.
• first_event_timestamp (integer, optional) Timestamp for when the event first occurred. Use an integer representing Unix time.
• user_identifier (string, optional) The unique identifier for the user to create event summaries for.

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.CreateMessageDataExport

Create a data export job for Intercom messages.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.CheckExportJobStatus

Check the status of your Intercom data export job.

Parameters

• job_identifier (string, required) The unique identifier for the export job you want to check. This ID is provided when the export job is created.

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.CancelDataExportJob

Cancels an active data export job on Intercom.

Parameters

• job_identifier (string, required) The unique identifier for the data export job to be canceled. This is required to specify which job to stop.

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.DownloadIntercomDataExport

Download completed data exports from Intercom.

Parameters

• job_identifier (string, required) The unique identifier for the completed data export job. Required to download the data.

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.CreateAdminInitiatedMessage

Create a message initiated by an admin via Intercom.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.FetchNewsItems

Retrieve a list of news items from Intercom.

Parameters

This tool does not take any parameters. Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.CreateNewsItem

Create a news item using Intercom.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.GetNewsItemDetails

Fetches details of a specific news item.

Parameters

• news_item_id (integer, required) The unique identifier for the news item provided by Intercom.

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.UpdateNewsItem

Updates information for a specific news item.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• news_item_id (integer, optional) The unique identifier for the news item provided by Intercom. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.DeleteNewsItem

Delete a specific news item from the platform.

Parameters

• news_item_id (integer, required) The unique identifier for the news item to be deleted.

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.FetchLiveNewsfeedItems

Retrieve all live news items from a specific newsfeed.

Parameters

• newsfeed_id (string, required) The unique identifier for the newsfeed, provided by Intercom, to retrieve live news items.

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.FetchAllNewsfeeds

Fetch a list of all available newsfeeds.

Parameters

This tool does not take any parameters. Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.FetchNewsfeedDetails

Fetch details of a specific newsfeed using its ID.

Parameters

• newsfeed_id (string, required) The unique identifier for the newsfeed item provided by Intercom. Use this to retrieve specific newsfeed details.

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.FetchNoteDetails

Fetches details of a specific note.

Parameters

• note_id (integer, required) The unique identifier for the note you want to retrieve details for.

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.GetAllSegments

Retrieve a list of all segments.

Parameters

• include_contact_count (boolean, optional) Set to true to include the number of contacts in each segment.

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.GetSegmentDetails

Fetch details of a single segment from Intercom.

Parameters

• segment_id (string, required) The unique identifier of a specific segment to retrieve details for.

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.ListSubscriptionTypes

Retrieve all subscription types from Intercom.

Parameters

This tool does not take any parameters. Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.DeflectPhoneCallsToMessenger

Deflect phone calls to Intercom Messenger via SMS link.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.FetchWorkspaceTags

Retrieve all tags from a workspace in Intercom.

Parameters

This tool does not take any parameters. Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.ManageTagOperations

Create, update, or manage tags for companies and users.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.FetchTagDetails

Fetch details of a tag using its ID from the workspace.

Parameters

• tag_id (string, required) The unique identifier for a specific tag to fetch its details from the workspace.

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.RemoveTag

Delete a tag from the Intercom workspace using its ID.

Parameters

• tag_id (string, required) The unique identifier of the tag to be deleted from the workspace.

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.ListAppTeams

Retrieve a list of teams for the application.

Parameters

This tool does not take any parameters. Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.GetTeamDetails

Fetch details of a team and its admins.

Parameters

• team_unique_identifier (string, required) The unique identifier of a specific team to retrieve details.

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.CreateTicketAttribute

Create a new attribute for a ticket type.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• ticket_type_identifier (string, optional) The unique identifier for the ticket type provided by Intercom, required to specify which ticket type the new attribute will be added to. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.UpdateTicketTypeAttribute

Updates an existing attribute for a ticket type.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• ticket_type_identifier (string, optional) The unique identifier for the ticket type provided by Intercom. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• ticket_attribute_id (string, optional) The unique identifier for the ticket type attribute given by Intercom. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.GetTicketTypes

Retrieve a list of all ticket types for a workspace.

Parameters

This tool does not take any parameters. Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.CreateTicketType

Create a new ticket type with default attributes.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.FetchTicketTypeDetails

Fetches details of a specific ticket type in Intercom.

Parameters

• ticket_type_id (string, required) The unique identifier for the ticket type assigned by Intercom. Used to fetch specific ticket type details.

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.UpdateTicketType

Update a ticket type with a new icon or details.

Parameters

• ticket_type_id (string, required) The unique identifier for the ticket type as given by Intercom.
• internal_use (boolean, optional) Set to true if tickets are intended for internal use only; false for customer sharing.
• is_ticket_type_archived (boolean, optional) Set to true to archive the ticket type, or false to keep it active.
• ticket_type_description (string, optional) Describe the ticket type. This should provide an overview or details about the ticket type.
• ticket_type_icon (string, optional) Specify an emoji for the ticket type icon using Twemoji Cheatsheet.
• ticket_type_name (string, optional) The name of the ticket type you want to update.

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.ReplyToTicket

Reply to a ticket with an admin note.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• ticket_id (string, optional) The unique identifier of the ticket to reply to. This must be provided to specify which ticket the admin note is for. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.CreateIntercomTicket

Create a new support ticket in Intercom.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.UpdateSupportTicket

Modify an existing support ticket in Intercom.

Parameters

• ticket_id (string, required) The unique identifier for the ticket as provided by Intercom.
• admin_id (string, optional) The ID of the admin performing the action on the ticket.
• assignee_id (string, optional) The ID of the admin or team to which the ticket is assigned. Use ‘0’ to unassign.
• ticket_details (json, optional) A JSON object containing key-value pairs of the ticket attributes to be updated, such as subject, priority, or tags.
• ticket_state (string, optional) The current state of the ticket. Must be one of: ‘in_progress’, ‘waiting_on_customer’, or ‘resolved’.
• ticket_visible_to_users (boolean, optional) Set to true to make the ticket visible to users; false to keep it hidden.

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.FetchTicketDetails

Fetch details of a specific ticket from Intercom.

Parameters

• ticket_identifier (string, required) The unique identifier for the ticket, as provided by Intercom.

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.UpdateVisitorInfo

Update an existing visitor’s information in Intercom.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.FetchVisitorDetails

Fetch details of a single visitor using their user ID.

Parameters

• visitor_user_id (string, required) The user ID of the visitor you want to retrieve details for.

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

IntercomApi.ConvertVisitorToUser

Convert a Visitor into a User or merge with an existing User.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: INTERCOM_API_SUBDOMAIN (learn how to configure secrets)

Reference

Below is a reference of enumerations used by some of the tools in the IntercomApi MCP Server:

ToolMode

• GET_REQUEST_SCHEMA: get_request_schema
• EXECUTE: execute

Auth

The IntercomApi MCP Server uses the Auth Provider with id arcade-intercom to connect to users’ IntercomApi accounts. In order to use the MCP Server, you will need to configure the arcade-intercom auth provider.

pip install arcade_intercom_api