Intercom API
Tools that enable LLMs to interact directly with the Intercom API
1.0.0
Arcade Toolkit for Intercom enables integration with the Intercom API, facilitating seamless interactions for managing contacts, conversations, and data attributes. This toolkit offers a variety of tools to streamline communication processes, ensuring effective customer engagement and support.
Capabilities:
- Automate contact management with CRUD operations.
- Streamline conversations by attaching contacts and companies.
- Support data exports and status checks for tracking user interactions.
- Create and manage notifications, messages, and knowledge base content.
- Track and manage tags for better organization.
OAuth:
- Provider: Unknown
- Scopes: None
Secrets:
- Types: webhook_secret, api_key, unknown, private_key
- Example: INTERCOM_API_SUBDOMAIN
Available tools(107)
| Tool name | Description | Secrets | |
|---|---|---|---|
Add a note to a contact in Intercom.
Use this tool to add a note to a specific contact in Intercom by specifying the contact's ID.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires path parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required path parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
| 1 | ||
Archive a single contact in Intercom.
Use this tool to archive a contact in Intercom by providing the contact's ID. This is helpful when managing contact lists and decluttering inactive contacts. | 1 | ||
Attach a company to a single contact in Intercom.
Use this tool to associate a specific company with a contact in the Intercom platform. It should be called when you need to link a contact to a company, enabling better organization and tracking within the system.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires path parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required path parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
| 1 | ||
Attach a contact to a conversation in Intercom.
Use this tool to add a contact as a participant to an Intercom conversation. If a contact is added via email and does not exist, a new contact with the role of 'lead' will be created. This is useful for managing participants in ongoing discussions.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires path parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required path parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
| 1 | ||
Auto-assign a conversation in Intercom.
Use this tool to automatically assign a conversation based on assignment rules in Intercom. Note that this functionality is deprecated in version 2.12 and later, and will be removed by December 31, 2026. This tool should not be used with Workflows. | 1 | ||
Cancels an active data export job on Intercom.
Use this tool to cancel an ongoing data export job on Intercom by providing the job identifier. | 1 | ||
Check the status of your Intercom data export job.
Use this tool to view the status of an export job in Intercom. It retrieves details about whether the job is still processing or completed, and notes the expiry of completed jobs, which is two days after completion. | 1 | ||
Convert a Visitor into a User or merge with an existing User.
Use this tool to convert a Visitor to a Contact of role type `lead` or `user`. If the User already exists, the Visitor will be merged into it and the User details will be returned. If the User does not exist, the Visitor will become a User, with their identifiers updated.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | 1 | ||
Create a message initiated by an admin via Intercom.
This tool allows you to create a message initiated by an admin, either as an in-app message or an email, using Intercom. Note that there might be a delay before a new contact can be messaged. The created message model is returned.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | 1 | ||
Create a conversation initiated by a contact.
This tool creates a conversation that has been initiated by a contact, which can be a user or a lead. It supports in-app messages and can handle visitors by converting them to contacts with a lead role. Use this tool to initiate communication with contacts effectively.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | 1 | ||
Create a data attribute for a contact or company.
This tool allows you to create a data attribute for a contact or company using the Intercom API. Use this when you need to add a new attribute to store additional information.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | 1 | ||
Create event summaries for tracking user events.
This tool creates event summaries for a user, tracking the number of times an event has occurred along with the first and last occurrence. | 1 | ||
Create a new collection in the Intercom Help Center.
This tool allows you to create a new collection in the Intercom Help Center by sending a POST request. Use it when you need to organize content into a new collection.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | 1 | ||
Create a new section in the help center.
This tool calls the Intercom API to create a new section in the help center by making a POST request. Use this when you need to organize help center content into a new section.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | 1 | ||
Create a new article in Intercom.
Use this tool to create a new article within the Intercom platform. It should be called when a new knowledge base article is needed.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | 1 | ||
Create a new support ticket in Intercom.
Use this tool to generate a new support ticket via Intercom. Ideal for handling customer queries or issues by automatically logging them into the ticketing system.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | 1 | ||
Create a data export job for Intercom messages.
This tool creates a data export job for message content within specified date ranges in Intercom. Only one active export job is permitted per workspace. Dates include all data from the specified start to end dates.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | 1 | ||
Create a new contact in the Intercom system.
Use this tool to add a new contact, either a user or a lead, to the Intercom database.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | 1 | ||
Create a news item using Intercom.
This tool allows the creation of a news item via Intercom's API. Use it when you need to publish or distribute a new piece of news.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | 1 | ||
Create or update a company in Intercom.
This tool is used to create or update a company in Intercom. The company is identified by a unique `company_id`. If a company with the given `company_id` exists, it will be updated; otherwise, a new company will be created. Note that a company will only be visible when associated with at least one user.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | 1 | ||
Create a new attribute for a ticket type.
Use this tool to add a custom attribute to a specified ticket type within the Intercom service. Ideal for augmenting ticket types with additional metadata.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires path parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required path parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
| 1 | ||
Create a new ticket type with default attributes.
This tool allows creating a new ticket type in Intercom, including default title and description attributes. An emoji icon can be added using the Twemoji Cheatsheet.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | 1 | ||
Deflect phone calls to Intercom Messenger via SMS link.
Use this tool to send an SMS with a link to the Intercom Messenger, redirecting phone calls to the Messenger. If custom attributes are provided, they will be added to the user or lead's custom data.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | 1 | ||
Delete a specified collection in Intercom.
Use this tool to delete a specific collection from Intercom by providing the collection ID. This action is irreversible, so ensure you want to permanently remove the collection. | 1 | ||
Deletes a single company by its ID.
Use this tool to remove a company from the Intercom system. It should be called when you need to delete a company identified by a specific ID. | 1 |
Selected tools
No tools selected.
Click "Show all tools" to add tools.
Requirements
Select tools to see requirements
IntercomApi.AddNoteToContact
Add a note to a contact in Intercom. Use this tool to add a note to a specific contact in Intercom by specifying the contact's ID. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
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' |
Requirements
Output
json— Response from the API endpoint 'createNote'.IntercomApi.ArchiveContact
Archive a single contact in Intercom. Use this tool to archive a contact in Intercom by providing the contact's ID. This is helpful when managing contact lists and decluttering inactive contacts.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
contact_id | string | Required | The unique identifier of the contact to be archived in Intercom. |
Requirements
Output
json— Response from the API endpoint 'ArchiveContact'.IntercomApi.AttachCompanyToContact
Attach a company to a single contact in Intercom. Use this tool to associate a specific company with a contact in the Intercom platform. It should be called when you need to link a contact to a company, enabling better organization and tracking within the system. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
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' |
Requirements
Output
json— Response from the API endpoint 'attachContactToACompany'.IntercomApi.AttachContactToConversation
Attach a contact to a conversation in Intercom. Use this tool to add a contact as a participant to an Intercom conversation. If a contact is added via email and does not exist, a new contact with the role of 'lead' will be created. This is useful for managing participants in ongoing discussions. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
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' |
Requirements
Output
json— Response from the API endpoint 'attachContactToConversation'.IntercomApi.AutoAssignIntercomConversation
Auto-assign a conversation in Intercom. Use this tool to automatically assign a conversation based on assignment rules in Intercom. Note that this functionality is deprecated in version 2.12 and later, and will be removed by December 31, 2026. This tool should not be used with Workflows.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
conversation_id | string | Required | The unique identifier for the conversation provided by Intercom. |
Requirements
Output
json— Response from the API endpoint 'autoAssignConversation'.IntercomApi.CancelDataExportJob
Cancels an active data export job on Intercom. Use this tool to cancel an ongoing data export job on Intercom by providing the job identifier.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
job_identifier | string | Required | The unique identifier for the data export job to be canceled. This is required to specify which job to stop. |
Requirements
Output
json— Response from the API endpoint 'cancelDataExport'.IntercomApi.CheckExportJobStatus
Check the status of your Intercom data export job. Use this tool to view the status of an export job in Intercom. It retrieves details about whether the job is still processing or completed, and notes the expiry of completed jobs, which is two days after completion.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
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. |
Requirements
Output
json— Response from the API endpoint 'getDataExport'.IntercomApi.ConvertVisitorToUser
Convert a Visitor into a User or merge with an existing User. Use this tool to convert a Visitor to a Contact of role type `lead` or `user`. If the User already exists, the Visitor will be merged into it and the User details will be returned. If the User does not exist, the Visitor will become a User, with their identifiers updated. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'convertVisitor'.IntercomApi.CreateAdminInitiatedMessage
Create a message initiated by an admin via Intercom. This tool allows you to create a message initiated by an admin, either as an in-app message or an email, using Intercom. Note that there might be a delay before a new contact can be messaged. The created message model is returned. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'createMessage'.IntercomApi.CreateContactConversation
Create a conversation initiated by a contact. This tool creates a conversation that has been initiated by a contact, which can be a user or a lead. It supports in-app messages and can handle visitors by converting them to contacts with a lead role. Use this tool to initiate communication with contacts effectively. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'createConversation'.IntercomApi.CreateDataAttribute
Create a data attribute for a contact or company. This tool allows you to create a data attribute for a contact or company using the Intercom API. Use this when you need to add a new attribute to store additional information. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'createDataAttribute'.IntercomApi.CreateEventSummaries
Create event summaries for tracking user events. This tool creates event summaries for a user, tracking the number of times an event has occurred along with the first and last occurrence.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
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. |
Requirements
Output
json— Response from the API endpoint 'dataEventSummaries'.IntercomApi.CreateHelpCenterCollection
Create a new collection in the Intercom Help Center. This tool allows you to create a new collection in the Intercom Help Center by sending a POST request. Use it when you need to organize content into a new collection. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'createCollection'.IntercomApi.CreateHelpCenterSection
Create a new section in the help center. This tool calls the Intercom API to create a new section in the help center by making a POST request. Use this when you need to organize help center content into a new section. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'createSection'.IntercomApi.CreateIntercomArticle
Create a new article in Intercom. Use this tool to create a new article within the Intercom platform. It should be called when a new knowledge base article is needed. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'createArticle'.IntercomApi.CreateIntercomTicket
Create a new support ticket in Intercom. Use this tool to generate a new support ticket via Intercom. Ideal for handling customer queries or issues by automatically logging them into the ticketing system. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'createTicket'.IntercomApi.CreateMessageDataExport
Create a data export job for Intercom messages. This tool creates a data export job for message content within specified date ranges in Intercom. Only one active export job is permitted per workspace. Dates include all data from the specified start to end dates. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'createDataExport'.IntercomApi.CreateNewContact
Create a new contact in the Intercom system. Use this tool to add a new contact, either a user or a lead, to the Intercom database. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'CreateContact'.IntercomApi.CreateNewsItem
Create a news item using Intercom. This tool allows the creation of a news item via Intercom's API. Use it when you need to publish or distribute a new piece of news. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'createNewsItem'.IntercomApi.CreateOrUpdateCompany
Create or update a company in Intercom. This tool is used to create or update a company in Intercom. The company is identified by a unique `company_id`. If a company with the given `company_id` exists, it will be updated; otherwise, a new company will be created. Note that a company will only be visible when associated with at least one user. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'createOrUpdateCompany'.IntercomApi.CreateTicketAttribute
Create a new attribute for a ticket type. Use this tool to add a custom attribute to a specified ticket type within the Intercom service. Ideal for augmenting ticket types with additional metadata. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
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' |
Requirements
Output
json— Response from the API endpoint 'createTicketTypeAttribute'.IntercomApi.CreateTicketType
Create a new ticket type with default attributes. This tool allows creating a new ticket type in Intercom, including default title and description attributes. An emoji icon can be added using the Twemoji Cheatsheet. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'createTicketType'.IntercomApi.DeflectPhoneCallsToMessenger
Deflect phone calls to Intercom Messenger via SMS link. Use this tool to send an SMS with a link to the Intercom Messenger, redirecting phone calls to the Messenger. If custom attributes are provided, they will be added to the user or lead's custom data. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'createPhoneSwitch'.IntercomApi.DeleteCollection
Delete a specified collection in Intercom. Use this tool to delete a specific collection from Intercom by providing the collection ID. This action is irreversible, so ensure you want to permanently remove the collection.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
collection_id | integer | Required | The unique identifier for the collection provided by Intercom, required to delete it. |
Requirements
Output
json— Response from the API endpoint 'deleteCollection'.IntercomApi.DeleteCompany
Deletes a single company by its ID. Use this tool to remove a company from the Intercom system. It should be called when you need to delete a company identified by a specific ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
company_id | string | Required | The unique identifier for the company to be deleted in Intercom. |
Requirements
Output
json— Response from the API endpoint 'deleteCompany'.IntercomApi.DeleteContact
Deletes a specified contact from the system. Use this tool to permanently delete a contact when you no longer need their information.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
contact_id | string | Required | The unique identifier of the contact to be deleted. |
Requirements
Output
json— Response from the API endpoint 'DeleteContact'.IntercomApi.DeleteIntercomArticle
Deletes a specified article in Intercom. Use this tool to delete an article by providing its unique ID on Intercom. It's useful for managing and removing outdated or incorrect articles from the Intercom system.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
article_id | integer | Required | The unique identifier for the article to be deleted, provided by Intercom. |
Requirements
Output
json— Response from the API endpoint 'deleteArticle'.IntercomApi.DeleteIntercomSection
Delete a section from Intercom Help Center. Use this tool to delete a specific section from the Intercom Help Center by providing the section ID. It is helpful when managing help center content and removing sections that are no longer needed.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
section_id | integer | Required | The unique identifier for the section to be deleted from Intercom. Provided by Intercom. |
Requirements
Output
json— Response from the API endpoint 'deleteSection'.IntercomApi.DeleteNewsItem
Delete a specific news item from the platform. Use this tool to delete a specific news item by its ID. This helps in managing content by removing outdated or incorrect news items.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
news_item_id | integer | Required | The unique identifier for the news item to be deleted. |
Requirements
Output
json— Response from the API endpoint 'deleteNewsItem'.IntercomApi.DetachCompanyFromContact
Detach a company from a specified contact in Intercom. This tool is used to remove the association between a contact and a company within the Intercom platform. Call this tool when a contact needs to be unlinked from a company.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
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. |
Requirements
Output
json— Response from the API endpoint 'detachContactFromACompany'.IntercomApi.DetachContactFromConversation
Detach a contact from a conversation in Intercom. Use this tool to remove a participant who is a contact from a specific conversation within Intercom. The tool should be called when you need to unlink contacts from conversations on Intercom, using their conversation and contact IDs.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
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. |
Requirements
Output
json— Response from the API endpoint 'detachContactFromConversation'.IntercomApi.DownloadIntercomDataExport
Download completed data exports from Intercom. This tool downloads your exported message data from Intercom when the export job is complete and a download URL is available. The data is returned in a gzipped CSV format.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
job_identifier | string | Required | The unique identifier for the completed data export job. Required to download the data. |
Requirements
Output
json— Response from the API endpoint 'downloadDataExport'.IntercomApi.FetchAllContacts
Fetch a list of all contacts in your workspace. This tool retrieves a list of all contacts, including users or leads, in your Intercom workspace. It supports pagination to manage large datasets, defaulting to 50 results per page.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'ListContacts'.IntercomApi.FetchAllNewsfeeds
Fetch a list of all available newsfeeds. Use this tool to retrieve a complete list of newsfeeds from the service.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'listNewsfeeds'.IntercomApi.FetchCompanyContacts
Fetch a list of contacts for a specific company. Call this tool to retrieve all contacts associated with a specific company using the company ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
company_id | string | Required | The unique identifier for the company, provided by Intercom, to fetch associated contacts. |
Requirements
Output
json— Response from the API endpoint 'ListAttachedContacts'.IntercomApi.FetchCompanyDetails
Fetch detailed information about a single company. Use this tool to retrieve information about a company by providing its `company_id` or `name`. Additionally, it can fetch all companies filtered by `segment_id` or `tag_id`. Ideal for obtaining comprehensive company data.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
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. |
Requirements
Output
json— Response from the API endpoint 'retrieveCompany'.IntercomApi.FetchContactCompanies
Fetches a list of companies associated with a contact. Use this tool to retrieve a list of companies linked to a specific contact. It's useful for understanding the companies that a particular contact is associated with.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
contact_identifier | string | Required | The unique identifier for the contact provided by Intercom, required to fetch associated companies. |
Requirements
Output
json— Response from the API endpoint 'listCompaniesForAContact'.IntercomApi.FetchContactDetails
Fetch the details of a specific contact. Use this tool to obtain detailed information about a contact by providing their unique ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
contact_id | string | Required | The unique identifier of the contact you want to fetch details for. |
Requirements
Output
json— Response from the API endpoint 'ShowContact'.IntercomApi.FetchContactNotes
Fetches notes associated with a specific contact. Use this tool to retrieve all notes linked to a particular contact identified by their ID. It is useful for accessing and reviewing notes related to specific contacts.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
contact_id | integer | Required | The unique ID of the contact whose notes you want to fetch. |
Requirements
Output
json— Response from the API endpoint 'listNotes'.IntercomApi.FetchConversationList
Retrieve a list of conversations with optional pagination options. Use this tool to fetch a list of all conversations. It supports optional pagination by allowing you to specify the page size and a starting cursor.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
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. |
Requirements
Output
json— Response from the API endpoint 'listConversations'.IntercomApi.FetchIntercomArticle
Fetch details of a specific Intercom article by ID. Use this tool to retrieve information about a single article from Intercom by providing the article ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
article_id | integer | Required | The unique identifier for the article provided by Intercom. Use this to fetch article details. |
Requirements
Output
json— Response from the API endpoint 'retrieveArticle'.IntercomApi.FetchIntercomCollectionDetails
Fetches details of a specific Intercom collection. Use this tool to fetch and retrieve details about a specific collection from Intercom by providing the collection ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
collection_id | integer | Required | The unique identifier for the collection provided by Intercom. It is required to fetch a specific collection's details. |
Requirements
Output
json— Response from the API endpoint 'retrieveCollection'.IntercomApi.FetchLiveNewsfeedItems
Retrieve all live news items from a specific newsfeed. This tool fetches a list of all current live news items from a specified newsfeed using the newsfeed's unique ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
newsfeed_id | string | Required | The unique identifier for the newsfeed, provided by Intercom, to retrieve live news items. |
Requirements
Output
json— Response from the API endpoint 'listLiveNewsfeedItems'.IntercomApi.FetchNewsfeedDetails
Fetch details of a specific newsfeed using its ID. Use this tool to retrieve comprehensive details about a particular newsfeed by providing its unique ID. This can be called when you need to access information about a single newsfeed item.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
newsfeed_id | string | Required | The unique identifier for the newsfeed item provided by Intercom. Use this to retrieve specific newsfeed details. |
Requirements
Output
json— Response from the API endpoint 'retrieveNewsfeed'.IntercomApi.FetchNewsItems
Retrieve a list of news items from Intercom. Use this tool to fetch the latest news articles available through the Intercom service.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'listNewsItems'.IntercomApi.FetchNoteDetails
Fetches details of a specific note. Use this tool to retrieve the details of a single note based on its ID. It should be called when detailed information about a specific note is needed.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
note_id | integer | Required | The unique identifier for the note you want to retrieve details for. |
Requirements
Output
json— Response from the API endpoint 'retrieveNote'.IntercomApi.FetchTagDetails
Fetch details of a tag using its ID from the workspace. Use this tool to obtain information about specific tags in your workspace by providing the tag ID. It retrieves a tag object with relevant details.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
tag_id | string | Required | The unique identifier for a specific tag to fetch its details from the workspace. |
Requirements
Output
json— Response from the API endpoint 'findTag'.IntercomApi.FetchTicketDetails
Fetch details of a specific ticket from Intercom. Use this tool to retrieve comprehensive information about a specific Intercom ticket by providing its ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
ticket_identifier | string | Required | The unique identifier for the ticket, as provided by Intercom. |
Requirements
Output
json— Response from the API endpoint 'getTicket'.IntercomApi.FetchTicketTypeDetails
Fetches details of a specific ticket type in Intercom. Use this tool to retrieve information about a particular ticket type by its ID from the Intercom service.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
ticket_type_id | string | Required | The unique identifier for the ticket type assigned by Intercom. Used to fetch specific ticket type details. |
Requirements
Output
json— Response from the API endpoint 'getTicketType'.IntercomApi.FetchVisitorDetails
Fetch details of a single visitor using their user ID. Use this tool to retrieve information about a visitor based on their user ID from Intercom.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
visitor_user_id | string | Required | The user ID of the visitor you want to retrieve details for. |
Requirements
Output
json— Response from the API endpoint 'retrieveVisitorWithUserId'.IntercomApi.FetchWorkspaceAdmins
Retrieve a list of admins in a workspace. Use this tool to fetch and list all administrators associated with a specific workspace.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'listAdmins'.IntercomApi.FetchWorkspaceTags
Retrieve all tags from a workspace in Intercom. This tool fetches a list of all tags associated with a given workspace in Intercom. Use it to manage or organize content by accessing the available tags.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'listTags'.IntercomApi.GetAdminActivityLogs
Retrieve a log of activities by all admins in an app. Use this tool to get detailed logs of all activities performed by admins within the application. It provides insights into the actions and events conducted by administrative users.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
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. |
Requirements
Output
json— Response from the API endpoint 'listActivityLogs'.IntercomApi.GetAllSegments
Retrieve a list of all segments. Use this tool to fetch and display all segments in Intercom, allowing you to view and manage customer groupings efficiently.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
include_contact_count | boolean | Optional | Set to true to include the number of contacts in each segment. |
Requirements
Output
json— Response from the API endpoint 'listSegments'.IntercomApi.GetCompanyDetails
Retrieve detailed information about a specific company. This tool fetches details for a single company using its unique ID. Use it to obtain comprehensive information about a specific company, including any related data available.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
company_id | string | Required | The unique identifier for the company provided by Intercom. |
Requirements
Output
json— Response from the API endpoint 'RetrieveACompanyById'.IntercomApi.GetContactSegments
Fetch segments associated with a contact. Use this tool to retrieve a list of segments linked to a specific contact in Intercom. Call this when you need to understand segment associations for a given contact ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
contact_unique_identifier | string | Required | The unique identifier for the contact provided by Intercom. This is required to fetch associated segments. |
Requirements
Output
json— Response from the API endpoint 'listSegmentsForAContact'.IntercomApi.GetContactTags
Fetches tags attached to a specific contact. Use this tool to retrieve a list of all tags associated with a given contact in the Intercom system.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
contact_unique_identifier | string | Required | The unique identifier for the contact, provided by Intercom, used to fetch associated tags. |
Requirements
Output
json— Response from the API endpoint 'listTagsForAContact'.IntercomApi.GetConversationDetails
Fetch details of a specific conversation from Intercom. Use this tool to retrieve detailed information about a single conversation on Intercom, including up to 500 recent parts. Suitable for accessing conversation metadata, especially when the AI agent is enabled in your workspace.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
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. |
Requirements
Output
json— Response from the API endpoint 'retrieveConversation'.IntercomApi.GetCurrentAdminInfo
Retrieve details of the currently authorized Intercom admin. Call this tool to obtain information about the currently authorized admin along with the workspace details. Useful for understanding who is logged in and their associated workspace. Ensure email addresses of users in custom SSO flows are verified to avoid impersonation risks.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'identifyAdmin'.IntercomApi.GetHelpCenterDetails
Retrieve detailed information about a specific Help Center. This tool fetches details of a single Help Center using its ID, making it useful for obtaining specific information about the Help Center structure and contents.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
help_center_id | integer | Required | The unique identifier for the Help Center collection provided by Intercom. |
Requirements
Output
json— Response from the API endpoint 'retrieveHelpCenter'.IntercomApi.GetNewsItemDetails
Fetches details of a specific news item. Use this tool to retrieve full information about a particular news item using its unique identifier.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
news_item_id | integer | Required | The unique identifier for the news item provided by Intercom. |
Requirements
Output
json— Response from the API endpoint 'retrieveNewsItem'.IntercomApi.GetRecentHelpCenterSections
Fetches a list of all help center sections sorted by recent updates. This tool retrieves all help center sections from Intercom, sorted in descending order by their last update. It is useful for accessing the most recently updated sections first.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'listAllSections'.IntercomApi.GetSectionDetails
Fetch details of a specific help center section by ID. Use this tool to obtain information about a particular section within the help center. Provide the specific section ID to retrieve its details.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
section_id | integer | Required | The unique identifier for the help center section provided by Intercom. |
Requirements
Output
json— Response from the API endpoint 'retrieveSection'.IntercomApi.GetSegmentDetails
Fetch details of a single segment from Intercom. This tool retrieves detailed information about a specific segment in Intercom. It should be called when you need to access or display segment details. Useful for understanding user groups within Intercom.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
segment_id | string | Required | The unique identifier of a specific segment to retrieve details for. |
Requirements
Output
json— Response from the API endpoint 'retrieveSegment'.IntercomApi.GetTeamDetails
Fetch details of a team and its admins. Use this tool to fetch comprehensive details about a specific team, including the list of admins associated with it. It's useful for scenarios where you need to understand the team composition within Intercom.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
team_unique_identifier | string | Required | The unique identifier of a specific team to retrieve details. |
Requirements
Output
json— Response from the API endpoint 'retrieveTeam'.IntercomApi.GetTicketTypes
Retrieve a list of all ticket types for a workspace. This tool fetches a list of all available ticket types within a workspace, useful for understanding support categories.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'listTicketTypes'.IntercomApi.ListAppTeams
Retrieve a list of teams for the application. This tool is used to fetch all team objects associated with the application. It should be called when you need detailed information about the teams configured in the app.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'listTeams'.IntercomApi.ListCollections
Retrieve a list of all collections sorted by update date. Fetches all collections from Intercom's help center, ordered by the most recent update. Useful for accessing the latest changes.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'listAllCollections'.IntercomApi.ListCompaniesIntercom
Retrieve a sorted list of companies from Intercom. This tool retrieves a list of companies from Intercom, sorted by the most recent request date. Use this to access companies associated with users. Supports pagination for result control.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
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'. |
Requirements
Output
json— Response from the API endpoint 'listAllCompanies'.IntercomApi.ListCompanySegments
Fetch segments belonging to a specific company. Use this tool to retrieve a list of all segments attached to a specific company in Intercom. This is useful for understanding how a company is categorized or segmented within Intercom.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
company_id | string | Required | The unique identifier for the company provided by Intercom. |
Requirements
Output
json— Response from the API endpoint 'ListAttachedSegmentsForCompanies'.IntercomApi.ListContactSubscriptions
Retrieve subscription types associated with a contact. Fetch a list of subscription types associated with a contact, including both opt-in and opt-out types.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
contact_identifier | string | Required | The unique identifier provided by Intercom for the contact. |
Requirements
Output
json— Response from the API endpoint 'listSubscriptionsForAContact'.IntercomApi.ListHelpCenters
Retrieve a list of all Help Centers from Intercom. Use this tool to access and retrieve all available Help Centers from Intercom's API. This can be useful for users needing to manage or review the Help Centers associated with their Intercom account.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'listHelpCenters'.IntercomApi.ListRecentArticles
Fetches a list of all articles from Intercom. Use this tool to obtain a list of articles from Intercom, sorted by the most recently updated. Ideal for retrieving the latest content updates.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'listArticles'.IntercomApi.ListSubscriptionTypes
Retrieve all subscription types from Intercom. Use this tool to obtain a list of all available subscription types in Intercom, which can be useful for managing or displaying subscription options.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'listSubscriptionTypes'.IntercomApi.ListWorkspaceDataAttributes
Fetch data attributes for contacts, companies, or conversations. Use this tool to retrieve a comprehensive list of all data attributes associated with a workspace, specifically for contacts, companies, or conversations.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
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. |
Requirements
Output
json— Response from the API endpoint 'lisDataAttributes'.IntercomApi.ManageContactSubscription
Manage a contact's subscription preferences in Intercom. Use this tool to add a subscription type to a contact in Intercom. You can opt the contact in or out based on the subscription type selected. It returns the updated subscription type for the contact. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
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' |
Requirements
Output
json— Response from the API endpoint 'attachSubscriptionTypeToContact'.IntercomApi.ManageConversation
Manage and update conversation statuses or assignments. Use this tool to close, snooze, open, or assign conversations to an admin or team. It helps in efficiently managing conversation workflows and statuses. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
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' |
Requirements
Output
json— Response from the API endpoint 'manageConversation'.IntercomApi.ManageTagOperations
Create, update, or manage tags for companies and users. This tool allows you to create or update tags, and manage tagging or untagging companies and users. It automatically creates new tags if they don't exist, while executing the tagging operations. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'createTag'.IntercomApi.MergeContactIntercom
Merge a lead contact into a user contact in Intercom. Use this tool to merge a contact with a role of 'lead' into another contact with a role of 'user' on the Intercom platform. This is useful for unifying contact information and maintaining a clean contact database.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
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. |
Requirements
Output
json— Response from the API endpoint 'MergeContact'.IntercomApi.RedactConversationPartOrMessage
Redact specific parts or messages within a conversation. Use this tool to redact a specific part of a conversation or the original message source. Ensure the targeted part has a body if a conversation part is being redacted. For source messages, they must originate from a contact. If criteria are not met, an error will be returned. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'redactConversation'.IntercomApi.RemoveSubscriptionFromContact
Remove a specific subscription from a contact. Use this tool to remove a subscription type from a specific contact in Intercom. It returns details about the subscription type that was removed.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
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. |
Requirements
Output
json— Response from the API endpoint 'detachSubscriptionTypeToContact'.IntercomApi.RemoveTag
Delete a tag from the Intercom workspace using its ID. This tool deletes a tag from your Intercom workspace by using the tag's unique ID. Use it to manage and organize your workspace efficiently by removing unnecessary or outdated tags.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
tag_id | string | Required | The unique identifier of the tag to be deleted from the workspace. |
Requirements
Output
json— Response from the API endpoint 'deleteTag'.IntercomApi.RemoveTagFromContact
Remove a tag from a specific contact. This tool removes a specified tag from a given contact in Intercom, returning the details of the tag that was removed.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
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. |
Requirements
Output
json— Response from the API endpoint 'detachTagFromContact'.IntercomApi.RemoveTagFromConversation
Remove a tag from a specific conversation. Use this tool to remove a tag from a conversation on Intercom. It detaches the specified tag from the given conversation and returns information about the tag that was removed. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
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' |
Requirements
Output
json— Response from the API endpoint 'detachTagFromConversation'.IntercomApi.ReplyToIntercomConversation
Reply to a conversation in Intercom with a message or note. Use this tool to send a reply to an ongoing conversation in Intercom. It can be used to send messages from an admin, on behalf of a contact, or as a note for other admins. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
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' |
Requirements
Output
json— Response from the API endpoint 'replyConversation'.IntercomApi.ReplyToTicket
Reply to a ticket with an admin note. Use this tool to add a reply note to a specific ticket from an admin. Ideal for cases where you need to provide information or updates about a ticket directly from an admin's perspective. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
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' |
Requirements
Output
json— Response from the API endpoint 'replyTicket'.IntercomApi.RetrieveAdminDetails
Retrieve details of a specific admin from Intercom. Use this tool to get information about a specific admin in your Intercom system by providing the admin ID. It returns relevant data about the admin.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
admin_id | integer | Required | The unique identifier for the admin. Provide an integer value to retrieve the admin's details. |
Requirements
Output
json— Response from the API endpoint 'retrieveAdmin'.IntercomApi.ScrollThroughAllCompanies
Efficiently iterate over all companies using the scroll API. This tool should be used when you need to retrieve a large dataset of companies without encountering errors or performance issues. It utilizes the Scroll API to efficiently fetch companies in a dataset. The tool handles the scroll parameter to continue fetching data sequentially. Beware of scroll expirations and network timeouts, which require restarting the scroll operation.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
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. |
Requirements
Output
json— Response from the API endpoint 'scrollOverAllCompanies'.IntercomApi.SearchConversations
Search conversations by specific attributes. This tool allows users to search for conversations in Intercom by defining specific attributes and filters. Use operators like AND/OR to refine your search, controlling the number of results with pagination. Call this tool when you need specific conversation details filtered by attributes such as id, created date, or author info. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'searchConversations'.IntercomApi.SearchIntercomContacts
Search for contacts by their attributes. Allows searching for multiple Intercom contacts using attribute-based filters. Supports combining filters with AND/OR operators to refine search results. Useful for retrieving specific contact data based on defined criteria. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'SearchContacts'.IntercomApi.SendIntercomEvent
Submit events to Intercom for user activity tracking. This tool is used to send events to Intercom, associating them with a user, lead, or visitor. It captures activities and actions taken by users in your application. Useful for tracking user interactions and behaviors, including metadata. Requires an Access Token with write permissions. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'createDataEvent'.IntercomApi.SetAdminAway
Mark an admin as away in the Intercom Inbox. This tool is used to set an admin's status to away in the Intercom Inbox. It should be called when there is a need to update an admin's availability status to unavailable or offline. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
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' |
Requirements
Output
json— Response from the API endpoint 'setAwayAdmin'.IntercomApi.TagContact
Attach a tag to a specific contact. Use this tool to tag a specific contact in your Intercom system. It helps organize and categorize contacts by attaching a tag, returning information about the tag added. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
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' |
Requirements
Output
json— Response from the API endpoint 'attachTagToContact'.IntercomApi.TagConversation
Attach a tag to a specific conversation. Use this tool to add a tag to a particular conversation. It returns a confirmation along with details about the tag added. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
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' |
Requirements
Output
json— Response from the API endpoint 'attachTagToConversation'.IntercomApi.UnarchiveContact
Unarchive a single contact in Intercom. Use this tool to unarchive a contact in Intercom by providing the contact ID. It allows reactivation of previously archived contacts.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
contact_id | string | Required | The unique identifier of the contact to unarchive in Intercom. |
Requirements
Output
json— Response from the API endpoint 'UnarchiveContact'.IntercomApi.UpdateArticleDetails
Update details of a specific article on Intercom. This tool updates the details of a specific article on Intercom. It should be called when you need to modify an existing article's information. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
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' |
Requirements
Output
json— Response from the API endpoint 'updateArticle'.IntercomApi.UpdateCollectionDetails
Update the details of a single collection. This tool updates the details of a specified collection in Intercom's database by making a PUT request. It should be called when you need to modify existing collection information. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
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' |
Requirements
Output
json— Response from the API endpoint 'updateCollection'.IntercomApi.UpdateCompanyInfo
Update company information by ID in Intercom. This tool updates a company's information using the Intercom provisioned ID. Note that the `company_id` cannot be changed after creation. Use this tool when you need to modify details of an existing company in Intercom.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
company_identifier | string | Required | The unique identifier assigned by Intercom for the company. Required to update company details. |
Requirements
Output
json— Response from the API endpoint 'UpdateCompany'.IntercomApi.UpdateConversation
Update an existing conversation. Use this tool to update details of an existing conversation without performing actions like replying or assigning. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
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' |
Requirements
Output
json— Response from the API endpoint 'updateConversation'.IntercomApi.UpdateDataAttribute
Update a data attribute's value via the API. Use this tool to update a data attribute's value on Intercom. Note that changing the data type via the API is not supported; it must be done through the UI.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
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`. |
Requirements
Output
json— Response from the API endpoint 'updateDataAttribute'.IntercomApi.UpdateHelpCenterSection
Update the details of a help center section. Use this tool to update the information of a specific section in the help center by specifying the section ID. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
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' |
Requirements
Output
json— Response from the API endpoint 'updateSection'.IntercomApi.UpdateIntercomContact
Update an existing Intercom contact's details. Use this tool to update information for a user or lead in Intercom. Call this tool when you need to modify existing contact details. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
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' |
Requirements
Output
json— Response from the API endpoint 'UpdateContact'.IntercomApi.UpdateNewsItem
Updates information for a specific news item. Call this tool to modify the details of an existing news item by its ID. Use it when you need to change or correct the content of a news article. The tool confirms whether the update was successful or not. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
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' |
Requirements
Output
json— Response from the API endpoint 'updateNewsItem'.IntercomApi.UpdateSupportTicket
Modify an existing support ticket in Intercom. Use this tool to update the details of a support ticket in Intercom, such as status, priority, or assigned agent. This is helpful for managing customer support requests efficiently.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
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. |
Requirements
Output
json— Response from the API endpoint 'updateTicket'.IntercomApi.UpdateTicketType
Update a ticket type with a new icon or details. Use this tool to update a ticket type in the system. You can modify attributes such as icon and other details. Ensure the icon is an emoji from the Twemoji Cheatsheet.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
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. |
Requirements
Output
json— Response from the API endpoint 'updateTicketType'.IntercomApi.UpdateTicketTypeAttribute
Updates an existing attribute for a ticket type. Use this tool to modify the attributes of a specific ticket type in Intercom by providing the ticket type and attribute IDs. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
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' |
Requirements
Output
json— Response from the API endpoint 'updateTicketTypeAttribute'.IntercomApi.UpdateVisitorInfo
Update an existing visitor's information in Intercom. Use this tool to update a visitor's information by providing their `user_id` or `id`. It sends a PUT request to modify the visitor's details in Intercom's system. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'updateVisitor'.