Intercom

Learn how to use Intercom with Composio

Overview

SLUG: INTERCOM

Description

Intercom provides live chat, messaging, and customer engagement tools, enabling businesses to drive conversions, handle support, and personalize communication at scale

Authentication Details

client_id
stringRequired
client_secret
stringRequired
full
stringDefaults to https://api.intercom.ioRequired
oauth_redirect_uri
stringDefaults to https://backend.composio.dev/api/v1/auth-apps/add
scopes
stringDefaults to read_user,write_user,read_company,write_company,read_conversation,write_conversation,read_admin,write_admin,read_tag,write_tag,read_event,write_event,read_segment,write_segment,read_count,write_count,read_data_attribute,write_data_attribute,read_ticket,write_ticket,read_team,write_team,read_note,write_note,read_news,write_news,read_article,write_article,read_webhook,write_webhook,offline_access

Connecting to Intercom

Create an auth config

Use the dashboard to create an auth config for the Intercom toolkit. This allows you to connect multiple Intercom accounts to Composio for agents to use.

1

Select App

Navigate to Intercom.

2

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

3

Create and Get auth config ID

Click “Create Intercom Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using OAuth2

1from composio import Composio
2
3# Replace these with your actual values
4intercom_auth_config_id = "ac_YOUR_INTERCOM_CONFIG_ID" # Auth config ID created above
5user_id = "0000-0000-0000" # UUID from database/application
6
7composio = Composio()
8
9
10def authenticate_toolkit(user_id: str, auth_config_id: str):
11 connection_request = composio.connected_accounts.initiate(
12 user_id=user_id,
13 auth_config_id=auth_config_id,
14 )
15
16 print(
17 f"Visit this URL to authenticate Intercom: {connection_request.redirect_url}"
18 )
19
20 # This will wait for the auth flow to be completed
21 connection_request.wait_for_connection(timeout=15)
22 return connection_request.id
23
24
25connection_id = authenticate_toolkit(user_id, intercom_auth_config_id)
26
27# You can also verify the connection status using:
28connected_account = composio.connected_accounts.get(connection_id)
29print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Intercom toolkit’s playground

For code examples, see the Tool calling guide and Provider examples.

Tool List

Tool Name: Add subscription to a contact

Description

You can add a specific subscription to a contact. In Intercom, we have two different subscription types based on user consent - opt-out and opt-in: 1.Attaching a contact to an opt-out subscription type will opt that user out from receiving messages related to that subscription type. 2.Attaching a contact to an opt-in subscription type will opt that user in to receiving messages related to that subscription type. This will return a subscription type model for the subscription type that was added to the contact.

Action Parameters

consent_type
stringRequired
contact_id
stringRequired
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Add tag to a contact

Description

You can tag a specific contact. This will return a tag object for the tag that was added to the contact.

Action Parameters

contact_id
stringRequired
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Archive contact

Description

Tool to archive a single contact in Intercom. Use when you need to archive a contact by their ID.

Action Parameters

contact_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Assign conversation

Description

Assigns a conversation to a specific admin or team in Intercom

Action Parameters

admin_id
string
assignee_id
string
conversation_id
stringRequired
team_id
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Attach a contact to a company

Description

You can attach a company to a single contact.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Attach contact to conversation

Description

Tool to attach a contact participant to a conversation on behalf of admin or contact. Use when you need to add a new participant to an existing conversation.

Action Parameters

admin_id
stringRequired
conversation_id
stringRequired
customer
objectRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Attach tag to conversation

Description

Tool to add a tag to a specific conversation in Intercom. Use when you need to attach or tag a conversation.

Action Parameters

admin_id
stringRequired
conversation_id
stringRequired
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Attach tag to ticket

Description

Tool to add a tag to a ticket in Intercom. Use when you need to attach or add a specific tag to a ticket for categorization or tracking purposes.

Action Parameters

admin_id
stringRequired
id
stringRequired
ticket_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Block contact

Description

Tool to block a single contact in Intercom. Use when you need to block a contact, which will also archive their conversations.

Action Parameters

contact_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Cancel data export

Description

Tool to cancel an active content data export job. Use when you need to terminate an ongoing export and update its status to 'canceled'.

Action Parameters

job_identifier
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Close conversation

Description

Closes a conversation in Intercom, marking it as resolved

Action Parameters

admin_id
stringRequired
body
string
conversation_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create a collection

Description

You can create a new collection by making a POST request to `https://api.intercom.io/help_center/collections.`

Action Parameters

description
string
help_center_id
integer
name
stringRequired
parent_id
string
translated__content__ar__description
string
translated__content__ar__name
string
translated__content__ar__type
string
translated__content__bg__description
string
translated__content__bg__name
string
translated__content__bg__type
string
translated__content__bs__description
string
translated__content__bs__name
string
translated__content__bs__type
string
translated__content__ca__description
string
translated__content__ca__name
string
translated__content__ca__type
string
translated__content__cs__description
string
translated__content__cs__name
string
translated__content__cs__type
string
translated__content__da__description
string
translated__content__da__name
string
translated__content__da__type
string
translated__content__de__description
string
translated__content__de__name
string
translated__content__de__type
string
translated__content__el__description
string
translated__content__el__name
string
translated__content__el__type
string
translated__content__en__description
string
translated__content__en__name
string
translated__content__en__type
string
translated__content__es__description
string
translated__content__es__name
string
translated__content__es__type
string
translated__content__et__description
string
translated__content__et__name
string
translated__content__et__type
string
translated__content__fi__description
string
translated__content__fi__name
string
translated__content__fi__type
string
translated__content__fr__description
string
translated__content__fr__name
string
translated__content__fr__type
string
translated__content__he__description
string
translated__content__he__name
string
translated__content__he__type
string
translated__content__hr__description
string
translated__content__hr__name
string
translated__content__hr__type
string
translated__content__hu__description
string
translated__content__hu__name
string
translated__content__hu__type
string
translated__content__id__description
string
translated__content__id__name
string
translated__content__id__type
string
translated__content__it__description
string
translated__content__it__name
string
translated__content__it__type
string
translated__content__ja__description
string
translated__content__ja__name
string
translated__content__ja__type
string
translated__content__ko__description
string
translated__content__ko__name
string
translated__content__ko__type
string
translated__content__lt__description
string
translated__content__lt__name
string
translated__content__lt__type
string
translated__content__lv__description
string
translated__content__lv__name
string
translated__content__lv__type
string
translated__content__mn__description
string
translated__content__mn__name
string
translated__content__mn__type
string
translated__content__nb__description
string
translated__content__nb__name
string
translated__content__nb__type
string
translated__content__nl__description
string
translated__content__nl__name
string
translated__content__nl__type
string
translated__content__pl__description
string
translated__content__pl__name
string
translated__content__pl__type
string
translated__content__pt__BR__description
string
translated__content__pt__BR__name
string
translated__content__pt__BR__type
string
translated__content__pt__description
string
translated__content__pt__name
string
translated__content__pt__type
string
translated__content__ro__description
string
translated__content__ro__name
string
translated__content__ro__type
string
translated__content__ru__description
string
translated__content__ru__name
string
translated__content__ru__type
string
translated__content__sl__description
string
translated__content__sl__name
string
translated__content__sl__type
string
translated__content__sr__description
string
translated__content__sr__name
string
translated__content__sr__type
string
translated__content__sv__description
string
translated__content__sv__name
string
translated__content__sv__type
string
translated__content__tr__description
string
translated__content__tr__name
string
translated__content__tr__type
string
translated__content__type
string
translated__content__vi__description
string
translated__content__vi__name
string
translated__content__vi__type
string
translated__content__zh__CN__description
string
translated__content__zh__CN__name
string
translated__content__zh__CN__type
string
translated__content__zh__TW__description
string
translated__content__zh__TW__name
string
translated__content__zh__TW__type
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create an article

Description

You can create a new article by making a POST request to `https://api.intercom.io/articles`.

Action Parameters

author_id
integerRequired
body
string
description
string
parent_id
integer
parent_type
string
state
string
title
stringRequired
translated__content__ar__author__id
integer
translated__content__ar__body
string
translated__content__ar__created__at
integer
translated__content__ar__description
string
translated__content__ar__state
string
translated__content__ar__title
string
translated__content__ar__type
string
translated__content__ar__updated__at
integer
translated__content__ar__url
string
translated__content__bg__author__id
integer
translated__content__bg__body
string
translated__content__bg__created__at
integer
translated__content__bg__description
string
translated__content__bg__state
string
translated__content__bg__title
string
translated__content__bg__type
string
translated__content__bg__updated__at
integer
translated__content__bg__url
string
translated__content__bs__author__id
integer
translated__content__bs__body
string
translated__content__bs__created__at
integer
translated__content__bs__description
string
translated__content__bs__state
string
translated__content__bs__title
string
translated__content__bs__type
string
translated__content__bs__updated__at
integer
translated__content__bs__url
string
translated__content__ca__author__id
integer
translated__content__ca__body
string
translated__content__ca__created__at
integer
translated__content__ca__description
string
translated__content__ca__state
string
translated__content__ca__title
string
translated__content__ca__type
string
translated__content__ca__updated__at
integer
translated__content__ca__url
string
translated__content__cs__author__id
integer
translated__content__cs__body
string
translated__content__cs__created__at
integer
translated__content__cs__description
string
translated__content__cs__state
string
translated__content__cs__title
string
translated__content__cs__type
string
translated__content__cs__updated__at
integer
translated__content__cs__url
string
translated__content__da__author__id
integer
translated__content__da__body
string
translated__content__da__created__at
integer
translated__content__da__description
string
translated__content__da__state
string
translated__content__da__title
string
translated__content__da__type
string
translated__content__da__updated__at
integer
translated__content__da__url
string
translated__content__de__author__id
integer
translated__content__de__body
string
translated__content__de__created__at
integer
translated__content__de__description
string
translated__content__de__state
string
translated__content__de__title
string
translated__content__de__type
string
translated__content__de__updated__at
integer
translated__content__de__url
string
translated__content__el__author__id
integer
translated__content__el__body
string
translated__content__el__created__at
integer
translated__content__el__description
string
translated__content__el__state
string
translated__content__el__title
string
translated__content__el__type
string
translated__content__el__updated__at
integer
translated__content__el__url
string
translated__content__en__author__id
integer
translated__content__en__body
string
translated__content__en__created__at
integer
translated__content__en__description
string
translated__content__en__state
string
translated__content__en__title
string
translated__content__en__type
string
translated__content__en__updated__at
integer
translated__content__en__url
string
translated__content__es__author__id
integer
translated__content__es__body
string
translated__content__es__created__at
integer
translated__content__es__description
string
translated__content__es__state
string
translated__content__es__title
string
translated__content__es__type
string
translated__content__es__updated__at
integer
translated__content__es__url
string
translated__content__et__author__id
integer
translated__content__et__body
string
translated__content__et__created__at
integer
translated__content__et__description
string
translated__content__et__state
string
translated__content__et__title
string
translated__content__et__type
string
translated__content__et__updated__at
integer
translated__content__et__url
string
translated__content__fi__author__id
integer
translated__content__fi__body
string
translated__content__fi__created__at
integer
translated__content__fi__description
string
translated__content__fi__state
string
translated__content__fi__title
string
translated__content__fi__type
string
translated__content__fi__updated__at
integer
translated__content__fi__url
string
translated__content__fr__author__id
integer
translated__content__fr__body
string
translated__content__fr__created__at
integer
translated__content__fr__description
string
translated__content__fr__state
string
translated__content__fr__title
string
translated__content__fr__type
string
translated__content__fr__updated__at
integer
translated__content__fr__url
string
translated__content__he__author__id
integer
translated__content__he__body
string
translated__content__he__created__at
integer
translated__content__he__description
string
translated__content__he__state
string
translated__content__he__title
string
translated__content__he__type
string
translated__content__he__updated__at
integer
translated__content__he__url
string
translated__content__hr__author__id
integer
translated__content__hr__body
string
translated__content__hr__created__at
integer
translated__content__hr__description
string
translated__content__hr__state
string
translated__content__hr__title
string
translated__content__hr__type
string
translated__content__hr__updated__at
integer
translated__content__hr__url
string
translated__content__hu__author__id
integer
translated__content__hu__body
string
translated__content__hu__created__at
integer
translated__content__hu__description
string
translated__content__hu__state
string
translated__content__hu__title
string
translated__content__hu__type
string
translated__content__hu__updated__at
integer
translated__content__hu__url
string
translated__content__id__author__id
integer
translated__content__id__body
string
translated__content__id__created__at
integer
translated__content__id__description
string
translated__content__id__state
string
translated__content__id__title
string
translated__content__id__type
string
translated__content__id__updated__at
integer
translated__content__id__url
string
translated__content__it__author__id
integer
translated__content__it__body
string
translated__content__it__created__at
integer
translated__content__it__description
string
translated__content__it__state
string
translated__content__it__title
string
translated__content__it__type
string
translated__content__it__updated__at
integer
translated__content__it__url
string
translated__content__ja__author__id
integer
translated__content__ja__body
string
translated__content__ja__created__at
integer
translated__content__ja__description
string
translated__content__ja__state
string
translated__content__ja__title
string
translated__content__ja__type
string
translated__content__ja__updated__at
integer
translated__content__ja__url
string
translated__content__ko__author__id
integer
translated__content__ko__body
string
translated__content__ko__created__at
integer
translated__content__ko__description
string
translated__content__ko__state
string
translated__content__ko__title
string
translated__content__ko__type
string
translated__content__ko__updated__at
integer
translated__content__ko__url
string
translated__content__lt__author__id
integer
translated__content__lt__body
string
translated__content__lt__created__at
integer
translated__content__lt__description
string
translated__content__lt__state
string
translated__content__lt__title
string
translated__content__lt__type
string
translated__content__lt__updated__at
integer
translated__content__lt__url
string
translated__content__lv__author__id
integer
translated__content__lv__body
string
translated__content__lv__created__at
integer
translated__content__lv__description
string
translated__content__lv__state
string
translated__content__lv__title
string
translated__content__lv__type
string
translated__content__lv__updated__at
integer
translated__content__lv__url
string
translated__content__mn__author__id
integer
translated__content__mn__body
string
translated__content__mn__created__at
integer
translated__content__mn__description
string
translated__content__mn__state
string
translated__content__mn__title
string
translated__content__mn__type
string
translated__content__mn__updated__at
integer
translated__content__mn__url
string
translated__content__nb__author__id
integer
translated__content__nb__body
string
translated__content__nb__created__at
integer
translated__content__nb__description
string
translated__content__nb__state
string
translated__content__nb__title
string
translated__content__nb__type
string
translated__content__nb__updated__at
integer
translated__content__nb__url
string
translated__content__nl__author__id
integer
translated__content__nl__body
string
translated__content__nl__created__at
integer
translated__content__nl__description
string
translated__content__nl__state
string
translated__content__nl__title
string
translated__content__nl__type
string
translated__content__nl__updated__at
integer
translated__content__nl__url
string
translated__content__pl__author__id
integer
translated__content__pl__body
string
translated__content__pl__created__at
integer
translated__content__pl__description
string
translated__content__pl__state
string
translated__content__pl__title
string
translated__content__pl__type
string
translated__content__pl__updated__at
integer
translated__content__pl__url
string
translated__content__pt__BR__author__id
integer
translated__content__pt__BR__body
string
translated__content__pt__BR__created__at
integer
translated__content__pt__BR__description
string
translated__content__pt__BR__state
string
translated__content__pt__BR__title
string
translated__content__pt__BR__type
string
translated__content__pt__BR__updated__at
integer
translated__content__pt__BR__url
string
translated__content__pt__author__id
integer
translated__content__pt__body
string
translated__content__pt__created__at
integer
translated__content__pt__description
string
translated__content__pt__state
string
translated__content__pt__title
string
translated__content__pt__type
string
translated__content__pt__updated__at
integer
translated__content__pt__url
string
translated__content__ro__author__id
integer
translated__content__ro__body
string
translated__content__ro__created__at
integer
translated__content__ro__description
string
translated__content__ro__state
string
translated__content__ro__title
string
translated__content__ro__type
string
translated__content__ro__updated__at
integer
translated__content__ro__url
string
translated__content__ru__author__id
integer
translated__content__ru__body
string
translated__content__ru__created__at
integer
translated__content__ru__description
string
translated__content__ru__state
string
translated__content__ru__title
string
translated__content__ru__type
string
translated__content__ru__updated__at
integer
translated__content__ru__url
string
translated__content__sl__author__id
integer
translated__content__sl__body
string
translated__content__sl__created__at
integer
translated__content__sl__description
string
translated__content__sl__state
string
translated__content__sl__title
string
translated__content__sl__type
string
translated__content__sl__updated__at
integer
translated__content__sl__url
string
translated__content__sr__author__id
integer
translated__content__sr__body
string
translated__content__sr__created__at
integer
translated__content__sr__description
string
translated__content__sr__state
string
translated__content__sr__title
string
translated__content__sr__type
string
translated__content__sr__updated__at
integer
translated__content__sr__url
string
translated__content__sv__author__id
integer
translated__content__sv__body
string
translated__content__sv__created__at
integer
translated__content__sv__description
string
translated__content__sv__state
string
translated__content__sv__title
string
translated__content__sv__type
string
translated__content__sv__updated__at
integer
translated__content__sv__url
string
translated__content__tr__author__id
integer
translated__content__tr__body
string
translated__content__tr__created__at
integer
translated__content__tr__description
string
translated__content__tr__state
string
translated__content__tr__title
string
translated__content__tr__type
string
translated__content__tr__updated__at
integer
translated__content__tr__url
string
translated__content__type
string
translated__content__vi__author__id
integer
translated__content__vi__body
string
translated__content__vi__created__at
integer
translated__content__vi__description
string
translated__content__vi__state
string
translated__content__vi__title
string
translated__content__vi__type
string
translated__content__vi__updated__at
integer
translated__content__vi__url
string
translated__content__zh__CN__author__id
integer
translated__content__zh__CN__body
string
translated__content__zh__CN__created__at
integer
translated__content__zh__CN__description
string
translated__content__zh__CN__state
string
translated__content__zh__CN__title
string
translated__content__zh__CN__type
string
translated__content__zh__CN__updated__at
integer
translated__content__zh__CN__url
string
translated__content__zh__TW__author__id
integer
translated__content__zh__TW__body
string
translated__content__zh__TW__created__at
integer
translated__content__zh__TW__description
string
translated__content__zh__TW__state
string
translated__content__zh__TW__title
string
translated__content__zh__TW__type
string
translated__content__zh__TW__updated__at
integer
translated__content__zh__TW__url
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create a note

Description

You can add a note to a single contact.

Action Parameters

admin_id
string
body
stringRequired
contact_id
string
id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create contact

Description

Tool to create a new contact in Intercom workspace. Use when you need to add a user or lead to Intercom. At least one identifier (email, external_id, or role) must be provided.

Action Parameters

avatar
string
custom_attributes
object
email
string
external_id
string
last_seen_at
integer
name
string
owner_id
integer
phone
string
role
string
signed_up_at
integer
unsubscribed_from_emails
boolean

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create content import source

Description

Tool to create a new content import source for the Fin Content Library. Use when you need to create a container for External Pages to be ingested into Intercom's AI content system.

Action Parameters

status
string
sync_behavior
stringRequired
url
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create conversation

Description

Creates a new conversation in Intercom

Action Parameters

body
stringRequired
from_admin_id
string
from_contact_id
string
from_user_id
string
message_type
stringDefaults to inapp
subject
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create data attribute

Description

Tool to create a custom data attribute for contacts or companies. Use when you need to define a new attribute to track additional information beyond standard fields.

Action Parameters

data_type
stringRequired
description
string
messenger_writable
boolean
model
stringRequired
name
stringRequired
options
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create data event

Description

Tool to submit a data event to Intercom to track user activities. Use when you need to notify Intercom of user actions and changes. Events are detected as duplicates using workspace ID, contact identifier, event name, and timestamp.

Action Parameters

created_at
integerRequired
email
string
event_name
stringRequired
id
string
metadata
object
user_id
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create data export

Description

Tool to initiate an async data export job for message content. Use when you need to export messages created within a specific timeframe. Only one active job per workspace is allowed; exceeding this limit triggers a 429 error. Jobs expire two days after completion.

Action Parameters

created_at_after
integerRequired
created_at_before
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create external page

Description

Tool to create an external page in Fin Content Library or update an existing page by external ID. Use when you need to ingest new content or update existing content for AI-generated answers. Supports upsert behavior: if a page with the same source_id and external_id exists, it will be updated instead of creating a new one.

Action Parameters

ai_agent_availability
boolean
ai_copilot_availability
boolean
external_id
stringRequired
html
stringRequired
locale
stringRequired
source_id
integerRequired
title
stringRequired
url
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create help center section

Description

Tool to create a new help center section within a collection. Use when you need to add a new section to organize articles in the help center hierarchy (Help Center → Collections → Sections → Articles). Supports multilingual content via translated_content parameter.

Action Parameters

name
stringRequired
parent_id
stringRequired
translated_content
object

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create internal article

Description

Tool to create a new internal article for team knowledge sharing. Use when you need to add new internal documentation or knowledge base articles for team members.

Action Parameters

author_id
integerRequired
body
string
locale
string
owner_id
integerRequired
title
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create or update a company

Description

You can create or update a company. Companies will be only visible in Intercom when there is at least one associated user. Companies are looked up via `company_id` in a `POST` request, if not found via `company_id`, the new company will be created, if found, that company will be updated. {% admonition type="attention" name="Using `company_id`" %} You can set a unique `company_id` value when creating a company. However, it is not possible to update `company_id`. Be sure to set a unique value once upon creation of the company. {% /admonition %}

Action Parameters

company_id
string
custom_attributes
object
industry
string
monthly_spend
integer
name
string
plan
string
remote_created_at
integer
size
integer
website
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create or update tag

Description

Tool to create or update a tag, and optionally tag/untag companies or tag contacts. Use when you need to create a new tag, update an existing tag, or apply/remove tags to/from companies or users.

Action Parameters

companies
array
id
string
name
stringRequired
users
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create ticket

Description

Tool to create a ticket in Intercom to track customer requests and issues. Use when you need to create a new support ticket with specified type, contacts, and attributes.

Action Parameters

assignment
object
company_id
string
contacts
arrayRequired
conversation_to_link_id
string
created_at
integer
ticket_attributes
object
ticket_type_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create a ticket type

Description

Tool to create a new ticket type that defines the data structure for tracking customer requests. Use when you need to establish a new category of tickets with specific fields and states.

Action Parameters

category
stringRequired
description
string
icon
string
is_internal
boolean
name
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create ticket type attribute

Description

Tool to create a new attribute for a ticket type in Intercom. Use when you need to add custom attributes to ticket types for data collection.

Action Parameters

allow_multiple_values
boolean
data_type
stringRequired
description
stringRequired
list_items
string
multiline
boolean
name
stringRequired
required_to_create
boolean
required_to_create_for_contacts
boolean
ticket_type_id
stringRequired
visible_on_create
booleanDefaults to True
visible_to_contacts
booleanDefaults to True

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create export job

Description

Tool to create an export job for message data within a specified timeframe. Use when you need to export messages sent during a specific period. Only one active job per workspace is allowed at a time.

Action Parameters

created_at_after
integerRequired
created_at_before
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create event summaries

Description

Tool to create event summaries for a user to track event occurrences. Use when you need to bulk update event counts for a user.

Action Parameters

event_summaries
arrayRequired
user_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete a collection

Description

You can delete a single collection by making a DELETE request to `https://api.intercom.io/collections/<id>`.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete a company

Description

You can delete a single company.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete a contact

Description

You can delete a single contact.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete an article

Description

You can delete a single article by making a DELETE request to `https://api.intercom.io/articles/<id>`.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete a tag

Description

Tool to delete a tag from Intercom workspace. Use when you need to permanently remove a tag that is no longer needed.

Action Parameters

tag_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete a visitor

Description

Tool to delete a visitor from the Intercom workspace. Use when you need to permanently remove a visitor record.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete content import source

Description

Tool to delete a content import source and all its external pages. Use when you need to remove a content import source from Intercom. This operation is permanent and cannot be undone.

Action Parameters

source_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete external page

Description

Tool to delete an external page from content library and AI answers. Use when you need to remove an external page from Intercom's AI knowledge base.

Action Parameters

page_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete internal article

Description

Tool to delete a single internal article by ID. Use when you need to permanently remove an internal article from Intercom.

Action Parameters

internal_article_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete tag

Description

Tool to delete a tag from workspace by ID. Use when you need to permanently remove a tag that is no longer needed.

Action Parameters

tag_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete ticket

Description

Tool to delete a ticket from the Intercom system. Use when you need to permanently remove a ticket.

Action Parameters

ticket_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Detach a contact from tag

Description

Tool to remove a tag from a specific contact in Intercom. Use when you need to detach or untag a contact.

Action Parameters

contact_id
stringRequired
tag_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Detach a contact from a company

Description

You can detach a company from a single contact.

Action Parameters

contact_id
stringRequired
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Detach contact from company

Description

Tool to detach a contact from a company in Intercom. Use when you need to remove a company association from a contact.

Action Parameters

company_id
stringRequired
contact_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Detach tag from conversation

Description

Tool to remove a tag from a specific conversation in Intercom. Use when you need to detach or untag a conversation.

Action Parameters

admin_id
stringRequired
conversation_id
stringRequired
tag_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Detach tag from ticket

Description

Tool to remove a tag from a ticket in Intercom. Use when you need to detach or remove a specific tag from a ticket.

Action Parameters

admin_id
stringRequired
tag_id
stringRequired
ticket_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Download data export

Description

Tool to download content data export from Intercom. Use when you need to retrieve exported message data from a completed data export job. The data is returned as a gzipped CSV file stream.

Action Parameters

job_identifier
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Enqueue create ticket

Description

Tool to enqueue ticket creation for asynchronous processing. Use when you need to create a ticket in Intercom. The system attempts validation on inputs before tasks are enqueued.

Action Parameters

assignment
object
company_id
string
contacts
arrayRequired
conversation_to_link_id
string
created_at
integer
skip_notifications
boolean
ticket_attributes
object
ticket_type_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Find a tag

Description

Tool to retrieve details for a specific tag by its ID. Use when you need to get information about a particular tag in the workspace.

Action Parameters

tag_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get a contact

Description

You can fetch the details of a single contact.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get content import source

Description

Tool to retrieve a content import source by its ID. Use when you need to fetch details about a specific content import source from Intercom's AI features.

Action Parameters

source_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get conversation

Description

Retrieves a specific conversation by ID with all messages and details

Action Parameters

conversation_id
stringRequired
display_as
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get entity counts

Description

Tool to retrieve summary counts for Intercom app entities including companies, users, leads, tags, segments, and conversations. Use when you need to get statistics about the total number of entities in the workspace or conversation counts.

Action Parameters

type
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get custom object instance by external ID

Description

Tool to retrieve a custom object instance by its external_id. Use when you need to fetch a specific custom object instance from Intercom using an identifier from your external system rather than Intercom's internal ID.

Action Parameters

custom_object_type_identifier
stringRequired
external_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get data export

Description

Tool to retrieve data from a completed reporting data export job. Returns a gzipped CSV file with exported data. Jobs expire two days after completion.

Action Parameters

job_identifier
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get external page

Description

Tool to retrieve an external page from Fin Content Library by ID. Use when you need to fetch details of a specific external page including its content, metadata, and AI availability settings.

Action Parameters

page_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get ticket

Description

Tool to retrieve a ticket from Intercom. Use when you need to fetch comprehensive details about a specific ticket including state, type, attributes, and contacts.

Action Parameters

ticket_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get a ticket type

Description

Tool to retrieve details for a specific ticket type by its ID. Use when you need to get complete information about a ticket type including its attributes and states.

Action Parameters

ticket_type_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Identify an admin

Description

You can view the currently authorised admin along with the embedded app object (a "workspace" in legacy terminology). > 🚧 Single Sign On > > If you are building a custom "Log in with Intercom" flow for your site, and you call the `/me` endpoint to identify the logged-in user, you should not accept any sign-ins from users with unverified email addresses as it poses a potential impersonation security risk.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Retrieve job status

Description

Tool to retrieve the status of job execution. Use when checking progress and outcome of asynchronous operations like data imports or exports.

Action Parameters

job_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List all activity logs

Description

You can get a log of activities by all admins in an app.

Action Parameters

created_at_after
stringRequired
created_at_before
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List all admins

Description

You can fetch a list of admins for a given workspace.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List all articles

Description

You can fetch a list of all articles by making a GET request to `https://api.intercom.io/articles`. > 📘 How are the articles sorted and ordered? > > Articles will be returned in descending order on the `updated_at` attribute. This means if you need to iterate through results then we'll show the most recently updated articles first.

Action Parameters

Action Response

data
arrayRequired
error
string
pages
objectRequired
successful
booleanRequired
total_count
integerRequired
type
stringRequired

Tool Name: List all collections

Description

You can fetch a list of all collections by making a GET request to `https://api.intercom.io/help_center/collections`. Collections will be returned in descending order on the `updated_at` attribute. This means if you need to iterate through results then we'll show the most recently updated collections first.

Action Parameters

Action Response

data
arrayRequired
error
string
pages
objectRequired
successful
booleanRequired
totalCount
integerRequired
type
stringRequired

Tool Name: List all companies

Description

You can list companies. The company list is sorted by the `last_request_at` field and by default is ordered descending, most recently requested first. Note that the API does not include companies who have no associated users in list responses. When using the Companies endpoint and the pages object to iterate through the returned companies, there is a limit of 10,000 Companies that can be returned. If you need to list or iterate on more than 10,000 Companies, please use the [Scroll API](https://developers.intercom.com/reference#iterating-over-all-companies). {% admonition type="warning" name="Pagination" %} You can use pagination to limit the number of results returned. The default is `20` results per page. See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#pagination-for-list-apis) for more details on how to use the `starting_after` param. {% /admonition %}

Action Parameters

order
string
page
integer
per_page
integerDefaults to 15

Action Response

data
arrayRequired
error
string
pages
objectRequired
successful
booleanRequired
total_count
integerRequired
type
stringRequired

Tool Name: List all help centers

Description

You can list all Help Centers by making a GET request to `https://api.intercom.io/help_center/help_centers`.

Action Parameters

Action Response

data
arrayRequired
error
string
pages
object
successful
booleanRequired
total_count
integer
type
stringRequired

Tool Name: List all notes

Description

You can fetch a list of notes that are associated to a contact.

Action Parameters

id
integerRequired

Action Response

data
arrayRequired
error
string
pages
objectRequired
successful
booleanRequired
totalCount
integerRequired
type
stringRequired

Tool Name: List attached companies for contact

Description

You can fetch a list of companies that are associated to a contact.

Action Parameters

id
stringRequired

Action Response

data
arrayRequired
error
string
pages
object
successful
booleanRequired
total_count
integer
type
stringRequired

Tool Name: List attached contacts

Description

You can fetch a list of all contacts that belong to a company.

Action Parameters

id
stringRequired

Action Response

data
arrayRequired
error
string
pages
objectRequired
successful
booleanRequired
totalCount
integerRequired
type
stringRequired

Tool Name: List attached segments for companies

Description

You can fetch a list of all segments that belong to a company.

Action Parameters

id
stringRequired

Action Response

data
arrayRequired
error
string
successful
booleanRequired
type
stringRequired

Tool Name: List attached segments for contact

Description

You can fetch a list of segments that are associated to a contact.

Action Parameters

contact_id
stringRequired

Action Response

data
arrayRequired
error
string
pages
objectRequired
successful
booleanRequired
total_count
integerRequired
type
stringRequired

Tool Name: List away status reasons

Description

Tool to retrieve all away status reasons for a workspace including deleted ones. Use when you need to list available away status options for team members.

Action Parameters

Action Response

data
arrayRequired
error
string
successful
booleanRequired
type
stringRequired

Tool Name: List calls

Description

Tool to list all phone calls from Intercom with pagination support. Use when you need to retrieve call records, view call history, or iterate through calls.

Action Parameters

page
integerDefaults to 1
per_page
integerDefaults to 25

Action Response

data
arrayRequired
error
string
pages
objectRequired
successful
booleanRequired
total_count
integerRequired
type
stringRequired

Tool Name: List calls with transcripts

Description

Tool to retrieve calls by conversation IDs with transcripts when available. Use when you need to get call records with their transcripts for specific conversations. Maximum 20 conversation IDs per request.

Action Parameters

conversation_ids
arrayRequired

Action Response

data
arrayRequired
error
string
successful
booleanRequired

Tool Name: List all contacts

Description

Tool to list all contacts (users or leads) in your Intercom workspace with pagination support. Use when you need to retrieve multiple contacts or iterate through all contacts in the workspace.

Action Parameters

per_page
integerDefaults to 50
starting_after
string

Action Response

data
arrayRequired
error
string
pages
objectRequired
successful
booleanRequired
total_count
integerRequired
type
stringRequired

Tool Name: List content import sources

Description

Tool to retrieve all content import sources for the workspace. Use when you need to list all content sources for Fin Content Library.

Action Parameters

Action Response

data
arrayRequired
error
string
pages
object
successful
booleanRequired
total_count
integerRequired
type
stringRequired

Tool Name: List conversations

Description

Lists conversations from Intercom with filtering and pagination support

Action Parameters

assignee_id
string
display_as
string
per_page
integerDefaults to 20
starting_after
string
state
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List data attributes

Description

Tool to list all data attributes for contacts, companies, and conversations. Use when you need to retrieve metadata about available data attributes.

Action Parameters

include_archived
boolean
model
string

Action Response

data
arrayRequired
error
string
successful
booleanRequired
type
stringRequired

Tool Name: List data events

Description

Tool to retrieve a log of data events belonging to a customer. Use when you need to list events for a specific user. Note: Only events less than 90 days old can be listed.

Action Parameters

email
string
intercom_user_id
string
summary
boolean
user_id
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List external pages

Description

Tool to list all external pages from Fin Content Library. Use when you need to retrieve external pages used for AI-generated answers in Intercom.

Action Parameters

Action Response

data
arrayRequired
error
string
pages
object
successful
booleanRequired
total_count
integer
type
stringRequired

Tool Name: List help center sections

Description

Tool to fetch a list of all help center sections in descending order by updated_at. Use when you need to retrieve sections from the help center hierarchy (Help Center → Collections → Sections → Articles).

Action Parameters

per_page
integer
starting_after
string

Action Response

data
arrayRequired
error
string
pages
objectRequired
successful
booleanRequired
total_count
integerRequired
type
stringRequired

Tool Name: List internal articles

Description

Tool to list all internal articles in Intercom. Use when you need to retrieve all internal articles available in the workspace.

Action Parameters

Action Response

data
arrayRequired
error
string
pages
objectRequired
successful
booleanRequired
total_count
integerRequired
type
stringRequired

Tool Name: List all news items

Description

Tool to fetch a list of all news items from Intercom. Use when you need to retrieve news items posted in the workspace.

Action Parameters

Action Response

data
arrayRequired
error
string
pages
objectRequired
successful
booleanRequired
total_count
integerRequired
type
stringRequired

Tool Name: List all segments

Description

Tool to retrieve all segments defined within a workspace for filtering and categorizing contacts. Use when you need to get a list of all available segments or check segment counts.

Action Parameters

include_count
boolean

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List subscriptions for a contact

Description

You can fetch a list of subscription types that are attached to a contact. These can be subscriptions that a user has 'opted-in' to or has 'opted-out' from, depending on the subscription type. This will return a list of Subscription Type objects that the contact is associated with. The data property will show a combined list of: 1.Opt-out subscription types that the user has opted-out from. 2.Opt-in subscription types that the user has opted-in to receiving.

Action Parameters

contact_id
stringRequired

Action Response

data
arrayRequired
error
string
successful
booleanRequired
type
stringRequired

Tool Name: List subscription types

Description

Tool to list all subscription types available in the workspace. Use when you need to retrieve subscription configuration details including state, translations, consent type, and supported content types.

Action Parameters

Action Response

data
arrayRequired
error
string
successful
booleanRequired
type
stringRequired

Tool Name: List all tags

Description

Tool to fetch all tags for the workspace. Use when you need to retrieve all available tags that can be applied to contacts, companies, and conversations.

Action Parameters

Action Response

data
arrayRequired
error
string
successful
booleanRequired
type
stringRequired

Tool Name: List tags attached to a contact

Description

You can fetch a list of all tags that are attached to a specific contact.

Action Parameters

contact_id
stringRequired

Action Response

data
arrayRequired
error
string
pages
object
successful
booleanRequired
total_count
integerRequired
type
stringRequired

Tool Name: List all teams

Description

Tool to retrieve all teams within a workspace. Use when you need to get a list of all available teams, their members, or assignment configurations.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List all ticket states

Description

Tool to fetch all ticket states for the workspace. Use when you need to retrieve all configured ticket states, including both active and archived ones.

Action Parameters

Action Response

data
array
error
string
successful
booleanRequired
type
stringRequired

Tool Name: List all ticket types

Description

Tool to retrieve all ticket types for the workspace. Use when you need to get all available ticket type configurations including attributes and states.

Action Parameters

Action Response

data
arrayRequired
error
string
successful
booleanRequired
type
stringRequired

Tool Name: Merge a lead and a user

Description

You can merge a contact with a `role` of `lead` into a contact with a `role` of `user`.

Action Parameters

from
string
into
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Remove subscription from a contact

Description

You can remove a specific subscription from a contact. This will return a subscription type model for the subscription type that was removed from the contact.

Action Parameters

contact_id
stringRequired
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Remove tag from a contact

Description

You can remove tag from a specific contact. This will return a tag object for the tag that was removed from the contact.

Action Parameters

contact_id
stringRequired
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Reopen conversation

Description

Reopens a closed conversation in Intercom

Action Parameters

admin_id
stringRequired
body
string
conversation_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Reply to ticket

Description

Tool to reply to a ticket with a message from admin or contact, or with a note for admins. Use when you need to add a response or comment to an existing ticket.

Action Parameters

admin_id
string
attachment_urls
array
body
stringRequired
created_at
integer
email
string
intercom_user_id
string
message_type
stringRequired
ticket_id
stringRequired
user_id
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Reply to conversation

Description

Sends a reply to an existing conversation in Intercom

Action Parameters

admin_id
stringRequired
attachment_urls
array
conversation_id
stringRequired
message_body
stringRequired
message_type
stringDefaults to comment

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Retrieve a collection

Description

You can fetch the details of a single collection by making a GET request to `https://api.intercom.io/help_center/collections/<id>`.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Retrieve a company by id

Description

You can fetch a single company.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Retrieve a help center

Description

You can fetch the details of a single Help Center by making a GET request to `https://api.intercom.io/help_center/help_center/<id>`.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Retrieve job status

Description

Tool to retrieve the status of a data export job. Use when checking the progress of an export job by providing the job identifier.

Action Parameters

job_identifier
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Retrieve an admin

Description

You can retrieve the details of a single admin.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Retrieve an article

Description

You can fetch the details of a single article by making a GET request to `https://api.intercom.io/articles/<id>`.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Retrieve a segment

Description

Tool to retrieve details for a single segment by its ID. Use when you need to get information about a specific segment including its name, type, and optionally the count of items.

Action Parameters

include_count
boolean
segment_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Retrieve a team

Description

Tool to retrieve details of a single team with admin members. Use when you need to fetch information about a specific team by its ID.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Retrieve companies

Description

You can fetch a single company by passing in `company_id` or `name`. `https://api.intercom.io/companies?name={name}` `https://api.intercom.io/companies?company_id={company_id}` You can fetch all companies and filter by `segment_id` or `tag_id` as a query parameter. `https://api.intercom.io/companies?tag_id={tag_id}` `https://api.intercom.io/companies?segment_id={segment_id}`

Action Parameters

company_id
string
name
string
page
integer
per_page
integer
segment_id
string
tag_id
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Retrieve internal article

Description

Tool to retrieve an internal article by ID from Intercom. Use when you need to fetch details of a specific internal article including its title, body content, and metadata.

Action Parameters

internal_article_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Retrieve note

Description

Tool to retrieve details of a single note by its identifier. Use when you need to fetch the complete information about a specific note.

Action Parameters

note_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Retrieve a segment

Description

Tool to retrieve details for a single segment by its ID. Use when you need to get information about a specific segment.

Action Parameters

segment_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Retrieve a team

Description

Tool to retrieve detailed information about a specific team by ID. Use when you need to get team details including members and assignment configuration.

Action Parameters

team_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Retrieve visitor with user ID

Description

Tool to retrieve a specific visitor's details using their user_id. Use when you need to fetch comprehensive visitor information including profile data, location, and activity metrics.

Action Parameters

user_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Scroll over all companies

Description

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

Action Parameters

scroll_param
string

Action Response

data
arrayRequired
error
string
pages
scroll_param
stringRequired
successful
booleanRequired
total_count
integer
type
stringRequired

Tool Name: Search contacts

Description

Tool to search for contacts using query filters with operators. Use when finding contacts by role, email, name, or attributes.

Action Parameters

per_page
integer
query
stringRequired
starting_after
string

Action Response

data
array
error
string
pages
object
successful
booleanRequired
total_count
integer
type
string

Tool Name: Search conversations

Description

Searches for conversations using query string with support for filtering and sorting

Action Parameters

per_page
integerDefaults to 20
query
stringRequired
sort_field
stringDefaults to updated_at
sort_order
stringDefaults to descending
starting_after
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Search for articles

Description

You can search for articles by making a GET request to `https://api.intercom.io/articles/search`.

Action Parameters

help_center_id
integer
highlight
boolean
phrase
string
state
string

Action Response

data
objectRequired
error
string
pages
objectRequired
successful
booleanRequired
total_count
integerRequired
type
stringRequired

Tool Name: Search internal articles

Description

Tool to search for internal articles in Intercom. Use when you need to find internal articles, optionally filtered by folder ID.

Action Parameters

folder_id
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Search tickets

Description

Tool to search tickets in Intercom by filtering attribute values. Use when you need to find tickets matching specific criteria like state, creation date, assignment, or custom attributes.

Action Parameters

pagination
object
query
objectRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Set an admin to away

Description

You can set an Admin as away for the Inbox.

Action Parameters

away_mode_enabled
booleanDefaults to True
away_mode_reassign
boolean
id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Show call

Description

Tool to retrieve a single call by ID from Intercom. Use when you need to get detailed information about a specific phone call.

Action Parameters

call_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Show call transcript

Description

Tool to get call transcript by call ID. Use when you need to retrieve the transcript text from a recorded call.

Action Parameters

call_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Show contact by external ID

Description

Tool to retrieve a contact by their external ID. Use when you need to fetch contact details using an identifier from your external system rather than Intercom's internal ID. Only supports users, not leads.

Action Parameters

external_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Unarchive contact

Description

Tool to unarchive a previously archived contact in Intercom. Use when you need to restore an archived contact by their ID.

Action Parameters

contact_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update a collection

Description

You can update the details of a single collection by making a PUT request to `https://api.intercom.io/collections/<id>`.

Action Parameters

description
string
id
integerRequired
name
string
parent_id
string
translated__content__ar__description
string
translated__content__ar__name
string
translated__content__ar__type
string
translated__content__bg__description
string
translated__content__bg__name
string
translated__content__bg__type
string
translated__content__bs__description
string
translated__content__bs__name
string
translated__content__bs__type
string
translated__content__ca__description
string
translated__content__ca__name
string
translated__content__ca__type
string
translated__content__cs__description
string
translated__content__cs__name
string
translated__content__cs__type
string
translated__content__da__description
string
translated__content__da__name
string
translated__content__da__type
string
translated__content__de__description
string
translated__content__de__name
string
translated__content__de__type
string
translated__content__el__description
string
translated__content__el__name
string
translated__content__el__type
string
translated__content__en__description
string
translated__content__en__name
string
translated__content__en__type
string
translated__content__es__description
string
translated__content__es__name
string
translated__content__es__type
string
translated__content__et__description
string
translated__content__et__name
string
translated__content__et__type
string
translated__content__fi__description
string
translated__content__fi__name
string
translated__content__fi__type
string
translated__content__fr__description
string
translated__content__fr__name
string
translated__content__fr__type
string
translated__content__he__description
string
translated__content__he__name
string
translated__content__he__type
string
translated__content__hr__description
string
translated__content__hr__name
string
translated__content__hr__type
string
translated__content__hu__description
string
translated__content__hu__name
string
translated__content__hu__type
string
translated__content__id__description
string
translated__content__id__name
string
translated__content__id__type
string
translated__content__it__description
string
translated__content__it__name
string
translated__content__it__type
string
translated__content__ja__description
string
translated__content__ja__name
string
translated__content__ja__type
string
translated__content__ko__description
string
translated__content__ko__name
string
translated__content__ko__type
string
translated__content__lt__description
string
translated__content__lt__name
string
translated__content__lt__type
string
translated__content__lv__description
string
translated__content__lv__name
string
translated__content__lv__type
string
translated__content__mn__description
string
translated__content__mn__name
string
translated__content__mn__type
string
translated__content__nb__description
string
translated__content__nb__name
string
translated__content__nb__type
string
translated__content__nl__description
string
translated__content__nl__name
string
translated__content__nl__type
string
translated__content__pl__description
string
translated__content__pl__name
string
translated__content__pl__type
string
translated__content__pt__BR__description
string
translated__content__pt__BR__name
string
translated__content__pt__BR__type
string
translated__content__pt__description
string
translated__content__pt__name
string
translated__content__pt__type
string
translated__content__ro__description
string
translated__content__ro__name
string
translated__content__ro__type
string
translated__content__ru__description
string
translated__content__ru__name
string
translated__content__ru__type
string
translated__content__sl__description
string
translated__content__sl__name
string
translated__content__sl__type
string
translated__content__sr__description
string
translated__content__sr__name
string
translated__content__sr__type
string
translated__content__sv__description
string
translated__content__sv__name
string
translated__content__sv__type
string
translated__content__tr__description
string
translated__content__tr__name
string
translated__content__tr__type
string
translated__content__type
string
translated__content__vi__description
string
translated__content__vi__name
string
translated__content__vi__type
string
translated__content__zh__CN__description
string
translated__content__zh__CN__name
string
translated__content__zh__CN__type
string
translated__content__zh__TW__description
string
translated__content__zh__TW__name
string
translated__content__zh__TW__type
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update a company

Description

You can update a single company using the Intercom provisioned `id`. {% admonition type="attention" name="Using `company_id`" %} When updating a company it is not possible to update `company_id`. This can only be set once upon creation of the company. {% /admonition %}

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update a contact

Description

You can update an existing contact (ie. user or lead).

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update an article

Description

You can update the details of a single article by making a PUT request to `https://api.intercom.io/articles/<id>`.

Action Parameters

author_id
integer
body
string
description
string
id
integerRequired
parent_id
string
parent_type
string
state
string
title
string
translated__content__ar__author__id
integer
translated__content__ar__body
string
translated__content__ar__created__at
integer
translated__content__ar__description
string
translated__content__ar__state
string
translated__content__ar__title
string
translated__content__ar__type
string
translated__content__ar__updated__at
integer
translated__content__ar__url
string
translated__content__bg__author__id
integer
translated__content__bg__body
string
translated__content__bg__created__at
integer
translated__content__bg__description
string
translated__content__bg__state
string
translated__content__bg__title
string
translated__content__bg__type
string
translated__content__bg__updated__at
integer
translated__content__bg__url
string
translated__content__bs__author__id
integer
translated__content__bs__body
string
translated__content__bs__created__at
integer
translated__content__bs__description
string
translated__content__bs__state
string
translated__content__bs__title
string
translated__content__bs__type
string
translated__content__bs__updated__at
integer
translated__content__bs__url
string
translated__content__ca__author__id
integer
translated__content__ca__body
string
translated__content__ca__created__at
integer
translated__content__ca__description
string
translated__content__ca__state
string
translated__content__ca__title
string
translated__content__ca__type
string
translated__content__ca__updated__at
integer
translated__content__ca__url
string
translated__content__cs__author__id
integer
translated__content__cs__body
string
translated__content__cs__created__at
integer
translated__content__cs__description
string
translated__content__cs__state
string
translated__content__cs__title
string
translated__content__cs__type
string
translated__content__cs__updated__at
integer
translated__content__cs__url
string
translated__content__da__author__id
integer
translated__content__da__body
string
translated__content__da__created__at
integer
translated__content__da__description
string
translated__content__da__state
string
translated__content__da__title
string
translated__content__da__type
string
translated__content__da__updated__at
integer
translated__content__da__url
string
translated__content__de__author__id
integer
translated__content__de__body
string
translated__content__de__created__at
integer
translated__content__de__description
string
translated__content__de__state
string
translated__content__de__title
string
translated__content__de__type
string
translated__content__de__updated__at
integer
translated__content__de__url
string
translated__content__el__author__id
integer
translated__content__el__body
string
translated__content__el__created__at
integer
translated__content__el__description
string
translated__content__el__state
string
translated__content__el__title
string
translated__content__el__type
string
translated__content__el__updated__at
integer
translated__content__el__url
string
translated__content__en__author__id
integer
translated__content__en__body
string
translated__content__en__created__at
integer
translated__content__en__description
string
translated__content__en__state
string
translated__content__en__title
string
translated__content__en__type
string
translated__content__en__updated__at
integer
translated__content__en__url
string
translated__content__es__author__id
integer
translated__content__es__body
string
translated__content__es__created__at
integer
translated__content__es__description
string
translated__content__es__state
string
translated__content__es__title
string
translated__content__es__type
string
translated__content__es__updated__at
integer
translated__content__es__url
string
translated__content__et__author__id
integer
translated__content__et__body
string
translated__content__et__created__at
integer
translated__content__et__description
string
translated__content__et__state
string
translated__content__et__title
string
translated__content__et__type
string
translated__content__et__updated__at
integer
translated__content__et__url
string
translated__content__fi__author__id
integer
translated__content__fi__body
string
translated__content__fi__created__at
integer
translated__content__fi__description
string
translated__content__fi__state
string
translated__content__fi__title
string
translated__content__fi__type
string
translated__content__fi__updated__at
integer
translated__content__fi__url
string
translated__content__fr__author__id
integer
translated__content__fr__body
string
translated__content__fr__created__at
integer
translated__content__fr__description
string
translated__content__fr__state
string
translated__content__fr__title
string
translated__content__fr__type
string
translated__content__fr__updated__at
integer
translated__content__fr__url
string
translated__content__he__author__id
integer
translated__content__he__body
string
translated__content__he__created__at
integer
translated__content__he__description
string
translated__content__he__state
string
translated__content__he__title
string
translated__content__he__type
string
translated__content__he__updated__at
integer
translated__content__he__url
string
translated__content__hr__author__id
integer
translated__content__hr__body
string
translated__content__hr__created__at
integer
translated__content__hr__description
string
translated__content__hr__state
string
translated__content__hr__title
string
translated__content__hr__type
string
translated__content__hr__updated__at
integer
translated__content__hr__url
string
translated__content__hu__author__id
integer
translated__content__hu__body
string
translated__content__hu__created__at
integer
translated__content__hu__description
string
translated__content__hu__state
string
translated__content__hu__title
string
translated__content__hu__type
string
translated__content__hu__updated__at
integer
translated__content__hu__url
string
translated__content__id__author__id
integer
translated__content__id__body
string
translated__content__id__created__at
integer
translated__content__id__description
string
translated__content__id__state
string
translated__content__id__title
string
translated__content__id__type
string
translated__content__id__updated__at
integer
translated__content__id__url
string
translated__content__it__author__id
integer
translated__content__it__body
string
translated__content__it__created__at
integer
translated__content__it__description
string
translated__content__it__state
string
translated__content__it__title
string
translated__content__it__type
string
translated__content__it__updated__at
integer
translated__content__it__url
string
translated__content__ja__author__id
integer
translated__content__ja__body
string
translated__content__ja__created__at
integer
translated__content__ja__description
string
translated__content__ja__state
string
translated__content__ja__title
string
translated__content__ja__type
string
translated__content__ja__updated__at
integer
translated__content__ja__url
string
translated__content__ko__author__id
integer
translated__content__ko__body
string
translated__content__ko__created__at
integer
translated__content__ko__description
string
translated__content__ko__state
string
translated__content__ko__title
string
translated__content__ko__type
string
translated__content__ko__updated__at
integer
translated__content__ko__url
string
translated__content__lt__author__id
integer
translated__content__lt__body
string
translated__content__lt__created__at
integer
translated__content__lt__description
string
translated__content__lt__state
string
translated__content__lt__title
string
translated__content__lt__type
string
translated__content__lt__updated__at
integer
translated__content__lt__url
string
translated__content__lv__author__id
integer
translated__content__lv__body
string
translated__content__lv__created__at
integer
translated__content__lv__description
string
translated__content__lv__state
string
translated__content__lv__title
string
translated__content__lv__type
string
translated__content__lv__updated__at
integer
translated__content__lv__url
string
translated__content__mn__author__id
integer
translated__content__mn__body
string
translated__content__mn__created__at
integer
translated__content__mn__description
string
translated__content__mn__state
string
translated__content__mn__title
string
translated__content__mn__type
string
translated__content__mn__updated__at
integer
translated__content__mn__url
string
translated__content__nb__author__id
integer
translated__content__nb__body
string
translated__content__nb__created__at
integer
translated__content__nb__description
string
translated__content__nb__state
string
translated__content__nb__title
string
translated__content__nb__type
string
translated__content__nb__updated__at
integer
translated__content__nb__url
string
translated__content__nl__author__id
integer
translated__content__nl__body
string
translated__content__nl__created__at
integer
translated__content__nl__description
string
translated__content__nl__state
string
translated__content__nl__title
string
translated__content__nl__type
string
translated__content__nl__updated__at
integer
translated__content__nl__url
string
translated__content__pl__author__id
integer
translated__content__pl__body
string
translated__content__pl__created__at
integer
translated__content__pl__description
string
translated__content__pl__state
string
translated__content__pl__title
string
translated__content__pl__type
string
translated__content__pl__updated__at
integer
translated__content__pl__url
string
translated__content__pt__BR__author__id
integer
translated__content__pt__BR__body
string
translated__content__pt__BR__created__at
integer
translated__content__pt__BR__description
string
translated__content__pt__BR__state
string
translated__content__pt__BR__title
string
translated__content__pt__BR__type
string
translated__content__pt__BR__updated__at
integer
translated__content__pt__BR__url
string
translated__content__pt__author__id
integer
translated__content__pt__body
string
translated__content__pt__created__at
integer
translated__content__pt__description
string
translated__content__pt__state
string
translated__content__pt__title
string
translated__content__pt__type
string
translated__content__pt__updated__at
integer
translated__content__pt__url
string
translated__content__ro__author__id
integer
translated__content__ro__body
string
translated__content__ro__created__at
integer
translated__content__ro__description
string
translated__content__ro__state
string
translated__content__ro__title
string
translated__content__ro__type
string
translated__content__ro__updated__at
integer
translated__content__ro__url
string
translated__content__ru__author__id
integer
translated__content__ru__body
string
translated__content__ru__created__at
integer
translated__content__ru__description
string
translated__content__ru__state
string
translated__content__ru__title
string
translated__content__ru__type
string
translated__content__ru__updated__at
integer
translated__content__ru__url
string
translated__content__sl__author__id
integer
translated__content__sl__body
string
translated__content__sl__created__at
integer
translated__content__sl__description
string
translated__content__sl__state
string
translated__content__sl__title
string
translated__content__sl__type
string
translated__content__sl__updated__at
integer
translated__content__sl__url
string
translated__content__sr__author__id
integer
translated__content__sr__body
string
translated__content__sr__created__at
integer
translated__content__sr__description
string
translated__content__sr__state
string
translated__content__sr__title
string
translated__content__sr__type
string
translated__content__sr__updated__at
integer
translated__content__sr__url
string
translated__content__sv__author__id
integer
translated__content__sv__body
string
translated__content__sv__created__at
integer
translated__content__sv__description
string
translated__content__sv__state
string
translated__content__sv__title
string
translated__content__sv__type
string
translated__content__sv__updated__at
integer
translated__content__sv__url
string
translated__content__tr__author__id
integer
translated__content__tr__body
string
translated__content__tr__created__at
integer
translated__content__tr__description
string
translated__content__tr__state
string
translated__content__tr__title
string
translated__content__tr__type
string
translated__content__tr__updated__at
integer
translated__content__tr__url
string
translated__content__type
string
translated__content__vi__author__id
integer
translated__content__vi__body
string
translated__content__vi__created__at
integer
translated__content__vi__description
string
translated__content__vi__state
string
translated__content__vi__title
string
translated__content__vi__type
string
translated__content__vi__updated__at
integer
translated__content__vi__url
string
translated__content__zh__CN__author__id
integer
translated__content__zh__CN__body
string
translated__content__zh__CN__created__at
integer
translated__content__zh__CN__description
string
translated__content__zh__CN__state
string
translated__content__zh__CN__title
string
translated__content__zh__CN__type
string
translated__content__zh__CN__updated__at
integer
translated__content__zh__CN__url
string
translated__content__zh__TW__author__id
integer
translated__content__zh__TW__body
string
translated__content__zh__TW__created__at
integer
translated__content__zh__TW__description
string
translated__content__zh__TW__state
string
translated__content__zh__TW__title
string
translated__content__zh__TW__type
string
translated__content__zh__TW__updated__at
integer
translated__content__zh__TW__url
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update content import source

Description

Tool to update an existing content import source in Fin Content Library. Use when you need to modify the URL, sync behavior, or status of an existing content import source.

Action Parameters

source_id
stringRequired
status
string
sync_behavior
stringRequired
url
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update data attribute

Description

Tool to update an existing data attribute in Intercom. Use when you need to modify a data attribute's description, archive status, or messenger writability. Note: Changing a data attribute's type via the API is restricted and must be done through the UI.

Action Parameters

archived
boolean
data_attribute_id
integerRequired
description
string
messenger_writable
boolean
options
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update external page

Description

Tool to update an existing external page in Fin Content Library. Use when you need to modify the content, metadata, or availability settings of an external page. Only pages created through the API can be updated.

Action Parameters

external_id
stringRequired
fin_availability
boolean
html
stringRequired
locale
stringRequired
page_id
stringRequired
source_id
integerRequired
title
stringRequired
url
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update internal article

Description

Tool to update an internal article with new title, body, author or owner information. Use when you need to modify an existing internal article in Intercom.

Action Parameters

author_id
integerRequired
body
stringRequired
internal_article_id
integerRequired
owner_id
integerRequired
title
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update ticket

Description

Tool to update an existing ticket in Intercom. Use when you need to modify ticket attributes, state, assignment, or other properties.

Action Parameters

admin_id
integer
assignee_id
string
company_id
string
is_shared
boolean
open
boolean
snoozed_until
integer
ticket_attributes
object
ticket_id
stringRequired
ticket_state_id
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update a ticket type

Description

Tool to update an existing ticket type in the workspace. Use when you need to modify a ticket type's name, description, category, icon, or archive status.

Action Parameters

archived
boolean
category
string
description
string
icon
string
is_internal
boolean
name
string
ticket_type_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update ticket type attribute

Description

Tool to update an existing attribute for a ticket type. Use when you need to modify properties like description, visibility, or requirements for a ticket type attribute.

Action Parameters

allow_multiple_values
boolean
attribute_id
stringRequired
description
string
list_items
string
multiline
boolean
name
string
required_to_create
boolean
required_to_create_for_contacts
boolean
ticket_type_id
stringRequired
visible_on_create
boolean
visible_to_contacts
boolean

Action Response

data
objectRequired
error
string
successful
booleanRequired