Instant Connections

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.

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

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

Assigns a conversation to a specific admin or team in Intercom. Mutates live conversation state; confirm intent before bulk-assigning multiple conversations.

Tool to attach a contact to a company in Intercom. Use when you need to associate a contact with a company.

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.

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

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.

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

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

Closes a conversation in Intercom, marking it as resolved. Requires explicit user confirmation before calling; closing is irreversible without a separate reopen action. Send any reply via INTERCOM_REPLY_TO_CONVERSATION before calling this tool — parallel execution on the same conversation causes conflicts.

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

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

You can add a note to a single contact.

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.

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.

Creates a new conversation in Intercom. Requires exactly one of from_user_id or from_contact_id — both are schema-optional but at least one must be provided.

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.

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.

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.

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.

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.

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.

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 %}

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.

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.

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.

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.

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

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

You can delete a single company.

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

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

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

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

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.

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.

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

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

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

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

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

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

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.

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.

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.

You can fetch the details of a single contact.

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.

Retrieves a specific conversation by ID with all messages and details. Key response caveats: `conversation_parts` are paginated — walk all cursors for complete transcripts. Fields `title`, `subject`, `source.body`, `conversation_parts.body`, `statistics`, and some contact properties can be null. System/workflow events appear in `conversation_parts` with null `body` or `author`; `first_admin_reply_at` may be null despite actual replies — use `last_admin_reply_at` for SLA calculations. Attachment URLs in `conversation_parts` are short-lived — download promptly. The `state` field and `open` boolean can diverge — re-fetch to verify state before assign/reply/close actions. Timestamps are Unix epoch seconds UTC. Use this tool (not INTERCOM_SEARCH_CONVERSATIONS) when full message context is required.

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.

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.

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.

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.

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.

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.

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

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

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

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.

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.

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 %}

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

Tool to fetch a list of all macros (saved replies) in your workspace for use in automating responses. The macros are returned in descending order by updated_at. Use when you need to retrieve available macros or sync macro data.

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

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

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

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

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

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.

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.

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.

Tool to list all notes associated with a specific company. Use when you need to retrieve all notes that have been added to a company record.

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.

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

Lists all conversations from Intercom with pagination support. This endpoint does not support filtering by state, assignee, or other attributes - use INTERCOM_SEARCH_CONVERSATIONS for filtering. Paginate by reading pages.next.starting_after from each response and passing it as starting_after until pages.next is absent. Response fields including title, source.body, conversation_parts.body, and statistics may be null; guard before string operations.

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

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.

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.

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).

Fetches one page of internal articles from Intercom. Uses Intercom's cursor-based pagination via `starting_after`. ONE Intercom API call is made per invocation; pagination is caller-driven via the `starting_after` request parameter and the `next_starting_after` field in the response.

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

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.

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.

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.

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.

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

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.

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.

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

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

Tool to register a Fin Voice call with Intercom. Use when you need to create a record of an external voice call in Intercom, enabling AI-powered call analysis and customer interaction tracking.

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.

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

Reopens a closed conversation in Intercom. Only operates correctly on conversations in a closed state; verify state via INTERCOM_GET_CONVERSATION before calling, as using on open or snoozed conversations may produce unexpected results.

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.

Sends a reply to an existing conversation in Intercom. Always send reply before closing a conversation — never parallelize with INTERCOM_CLOSE_CONVERSATION on the same conversation. Verify conversation state via INTERCOM_GET_CONVERSATION before replying, as open/snoozed/closed states may diverge from cached values.

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

You can fetch a single company.

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>`.

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

Tool to fetch a single macro (saved reply) by its ID. The macro will only be returned if it is visible to the authenticated user based on its visibility settings.

You can retrieve the details of a single admin.

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

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.

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}`

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.

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

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

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.

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.

Tool to search for contacts using query filters with operators. Use when finding contacts by role, email, name, or attributes. Response entries may include null or non-dictionary values; guard against missing/null fields before accessing nested properties. A contact may have multiple emails or contact_ids; deduplicate when aggregating across searches.

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

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

Searches one page of internal articles in Intercom. Uses Intercom's cursor-based pagination via `starting_after`. ONE Intercom API call is made per invocation; pagination is caller-driven via the `starting_after` request parameter and the `next_starting_after` field in the response. Optionally filtered by `folder_id`.

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.

Tool to set an admin to away status in Intercom. Use when you need to mark an admin as away, optionally with a specific reason and reassignment behavior.

You can set an Admin as away for the Inbox.

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

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

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.

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

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

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 %}

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

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

Tool to update an existing contact in Intercom. Use when you need to modify contact information such as name, email, custom attributes, or other properties.

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.

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.

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.

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.

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

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.

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.

Add one or more gifts (donations) to an existing gift batch in Blackbaud Raiser's Edge NXT. Use this tool when you need to: - Append new gifts to an open batch for later processing - Batch multiple donations together before committing them - Add gifts with detailed information (payments, splits, custom fields) Prerequisites: - The batch must already exist (use a create batch action first if needed) - The batch must be in "open" status (not committed) - You need the batch_id (system record ID) and constituent_id (donor ID) for each gift Note: This action returns response details for all HTTP status codes (including errors). Check the status_code field in the response to determine success (200) vs errors (4xx/5xx).

Retrieves comprehensive gift details from Blackbaud Raiser's Edge NXT by gift ID. Use this tool when you need to fetch detailed information about a specific gift including: - Gift amount and currency - Donor/constituent information - Gift type and status - Important dates (gift date, post date) - Associated metadata and custom fields The gift_id is the unique system record ID (integer) that identifies the gift in Raiser's Edge NXT.

Retrieves comprehensive membership details from Blackbaud Raiser's Edge NXT by member junction ID. Fetches detailed information about a specific membership including program name, category/subcategory, membership status and standing (Active, Lapsed), start/expiration dates, dues information, and associated constituent ID. Requires a valid member_junction_id (GUID) that uniquely identifies a membership junction record linking a constituent to a membership program in Raiser's Edge NXT. Returns error information in the response object for graceful error handling in agent workflows.

Retrieves payment transaction details from Blackbaud SKY Payments API. Use this to check transaction status, amounts, payment methods, and error details. Transaction IDs come from payment processing endpoints, checkout callbacks, batch operations, or webhook notifications. Requires: Payments API subscription key (Bb-Api-Subscription-Key) and OAuth Bearer token. This retrieves existing transactions; it does not process new payments.

Tool to interact with Blackbaud OneRoster OAuth2 base endpoints. Use to fetch OpenID configuration (/.well-known/openid-configuration), JWKS key set (publickeys), or obtain an access token via the client credentials grant. Ensure client credentials are configured before using the token operation.

Tool to get brand details by brand ID. Use after obtaining the brand identifier.

Tool to list all brands in the account. Use after confirming account is authenticated.

Tool to create a brand-scoped custom field. Use when you need to define and register a new custom field for a specific brand.

Tool to edit an existing custom field. Use when you need to update a custom field's properties after creation.

Tool to list documents sent on behalf of users. Use when fetching and filtering documents you've sent or on behalf of others.

Tool to edit a draft or sent document. Use when updating files, recipients, or document settings before finalizing the document.

Tool to extend a document's expiry date. Use before signing to prolong a document's deadline.

Tool to list documents in My Documents with filters. Use when you need to fetch and filter documents based on various criteria.

Tool to remove authentication from a document. Use when you need to disable signer authentication on an existing document before the signing process.

Tool to send a document for eSignature. Use when you need to deliver documents to recipients for signing.

Tool to list team documents. Use when a team or account admin needs to retrieve all team documents with optional filters.

Tool to create an embedded request link. Use after specifying title and signers to generate an embeddable URL for in-app document preparation and sending.

Helper action to upload a file to R2 temp via the Xava file pipeline, returning a key that can be passed to FileUploadable fields in other actions (e.g., BrandLogo in brand create).

Tool to get remaining BoldSign API credits count. Use after authenticating your BoldSign account.

Tool to attach a file from a provided URL to a task. The file will be downloaded and attached asynchronously. Use when you need to add a file attachment to a task from a URL source.

Tool to create a new comment on a DART task. Use when you need to add feedback, notes, or discussion to a specific task. Supports markdown formatting and threaded replies via parentId.

Tool to add a time tracking entry to a DART task. Use when you need to record time spent on a specific task. The finishedAt timestamp must be after startedAt.

Tool to create a new doc in Dart. Use when you need to record a new document that the user intends to write down. By default, the created doc will be in the Docs folder unless a specific folder is specified.

Tool to create a new task in DART with title and optional metadata. Use when you need to add a task to a workspace.

Tool to move an existing doc to the trash where it can be recovered if needed. Use when you need to delete a doc without permanently removing it.

Tool to delete an existing task in Dart by moving it to trash. Use when a task needs to be removed but can be recovered later.

Tool to retrieve workspace configuration including dartboards, folders, types, statuses, and more. Use when you need to understand available options in the workspace.

Tool to retrieve an existing doc with metadata and content. Use when you need to access a specific document's details including title, folder, and text content.

Tool to retrieve an existing task with full details including title, dartboard, status, and description. Use when you need to fetch complete information about a specific task.

Tool to list comments for a task with filtering options. Use when you need to retrieve comments on a specific task. Supports filtering by author, text content, date range, and pagination. Can be ordered by date or hierarchical thread structure.

Tool to list docs with filtering and search capabilities. Use when you need to retrieve documents from DART with filters like folder, title, text content, or full-text search. Supports pagination and custom ordering by creation date, update date, or title.

Tool to search help center articles by semantic similarity to query. Use when you need to find relevant help articles based on a short search query (1-5 words). Returns up to two most relevant articles.

Tool to list tasks with powerful filtering options. Use when you need to retrieve tasks from DART with filters like dartboard, status, assignee, tags, priority, dates, or completion state. Supports pagination and custom ordering.

Tool to move a task to a specific position within its dartboard. Use when you need to reorder tasks in a list. Specify either afterTaskId or beforeTaskId to position the task.

Tool to retrieve a skill by its exact title from the workspace. Use when you need to find details about a specific skill including its ID and instructions.

Tool to update an existing doc in Dart. Use when you need to modify a document's title, folder location, or content. Any properties not specified will remain unchanged.

Tool to update an existing task in DART with new properties. Use when you need to modify a task's title, status, assignees, or other attributes. Only properties specified in the request will be updated.