Intercom
Source: https://runstack.engineer/docs/toolkits/intercom
Manage contacts, companies, conversations, tickets, articles, and events via the Intercom API v2.
Tools (133):
| Tool | Description |
|---|---|
intercomCreateContact | Create a new contact (user or lead) in the Intercom workspace. |
intercomGetContact | Fetch the details of a single contact by Intercom ID. |
intercomUpdateContactA | Update a contact by Intercom ID, optionally attaching companies afterwards. |
intercomUpdateContact | Update a contact name, email, role, attributes, or subscription flags. |
intercomDeleteContact | Permanently delete a contact from the Intercom workspace. |
intercomArchiveContact | Archive a single contact by ID. |
intercomUnarchiveContact | Unarchive (restore) a previously archived contact by ID. |
intercomBlockContact | Block a contact; their conversations are archived too. |
intercomMergeLeadAndUser | Merge a lead contact into a user contact. The lead is permanently removed. |
intercomSearchContacts | Search contacts with field/operator filters, e.g. role equals user. |
intercomListContacts | List all contacts (users and leads) with cursor pagination. |
intercomShowContactByExternalId | Fetch a contact by your external ID. Users only, not leads. |
intercomDeleteVisitor | Permanently delete a visitor record from the workspace. |
intercomRetrieveVisitor | Fetch a visitor profile, location, and activity by your user ID. |
intercomCreateNote | Add a note to a single contact. |
intercomListNotes | Fetch notes associated with a contact. |
intercomRetrieveNote | Fetch a single note by note ID. |
intercomAttachContactToCompany | Associate a contact with a company. |
intercomDetachContactFromCompany | Remove a company association from a contact. |
intercomListContactCompanies | Fetch companies associated with a contact. |
intercomListContactSegments | Fetch segments associated with a contact. |
intercomAddTagToContact | Attach a tag to a contact for categorization. |
intercomDetachContactFromTag | Remove a tag from a contact. |
intercomRemoveTagFromContact | Remove a tag from a specific contact, returning the removed tag. |
intercomListContactTags | Fetch all tags attached to a contact. |
intercomAddContactSubscription | Opt a contact in or out of a subscription type. |
intercomRemoveContactSubscription | Remove a subscription type from a contact. |
intercomListContactSubscriptions | Fetch opted-in and opted-out subscription types for a contact. |
intercomCreateOrUpdateCompany | Create a company by company_id, or update it when it already exists. |
intercomRetrieveCompanies | Fetch companies filtered by name, company_id, tag, or segment. |
intercomRetrieveCompanyById | Fetch a single company by Intercom ID. |
intercomUpdateCompany | Update a company by Intercom ID. company_id cannot be changed. |
intercomDeleteCompany | Delete a single company. |
intercomListCompanies | List companies sorted by recent activity, paginated. |
intercomScrollCompanies | Iterate all companies efficiently via the scroll API for huge datasets. |
intercomListCompanyContacts | Fetch all contacts belonging to a company. |
intercomListCompanySegments | Fetch segments that a company belongs to. |
intercomListCompanyNotes | Fetch notes added to a company record. |
intercomCreateConversation | Start a contact-initiated style conversation with a message from a user or contact. |
intercomGetConversation | Retrieve a conversation with messages and details. Prefer this for full context. |
intercomListConversations | List conversations with cursor pagination. No filtering; use search instead. |
intercomSearchConversations | Search conversations by state, dates, assignees, tags, and more. |
intercomReplyToConversation | Send an admin reply (comment or note) to a conversation. Reply before closing. |
intercomCloseConversation | Close (resolve) a conversation, optionally with a closing message. |
intercomReopenConversation | Reopen a closed conversation, optionally with a message. |
intercomAssignConversation | Assign a conversation to an admin or a team. |
intercomAttachContactToConversation | Add a contact participant to a conversation as an admin. |
intercomAttachTagToConversation | Attach a tag to a conversation. |
intercomDetachTagFromConversation | Remove a tag from a conversation. |
intercomCreateTicket | Create a support ticket for contacts with type, attributes, and assignment. |
intercomEnqueueCreateTicket | Enqueue ticket creation for async processing with validation first. |
intercomGetTicket | Fetch a ticket with state, type, attributes, and contacts. |
intercomUpdateTicket | Update ticket attributes, state, assignment, sharing, or snooze. |
intercomDeleteTicket | Permanently delete a ticket. |
intercomSearchTickets | Search tickets by state, dates, assignees, or custom attributes. |
intercomReplyTicket | Reply to a ticket as an admin (comment/note) or on behalf of a contact. |
intercomCreateTicketType | Create a ticket type defining structure and workflow for tickets. |
intercomGetTicketType | Fetch a ticket type with attributes and states. |
intercomListTicketTypes | List all ticket types in the workspace. |
intercomUpdateTicketType | Update a ticket type name, description, category, icon, or archive flag. |
intercomCreateTicketTypeAttribute | Add a custom attribute field to a ticket type. |
intercomUpdateTicketTypeAttribute | Update a ticket type attribute description, visibility, or requirements. |
intercomListTicketStates | Fetch all ticket states including archived ones. |
intercomAttachTagToTicket | Attach a tag to a ticket. |
intercomDetachTagFromTicket | Remove a tag from a ticket. |
intercomCreateCollection | Create a help center collection, optionally nested or translated. |
intercomRetrieveCollection | Fetch a single help center collection by ID. |
intercomListCollections | List help center collections, most recently updated first. |
intercomUpdateCollection | Update a help center collection name, description, or parent. |
intercomDeleteCollection | Delete a help center collection. |
intercomCreateHelpCenterSection | Create a help center section inside a collection for organizing articles. |
intercomListHelpCenterSections | List help center sections, most recently updated first. |
intercomListHelpCenters | List all help centers in the workspace. |
intercomRetrieveHelpCenter | Fetch a single help center by ID. |
intercomCreateArticle | Create a help center article as draft or published. |
intercomRetrieveArticle | Fetch a single article with statistics. |
intercomListArticles | List articles, most recently updated first. |
intercomUpdateArticle | Update an article title, body, state, author, or parent. |
intercomDeleteArticle | Delete a single article. |
intercomSearchArticles | Search articles by phrase, state, and help center. |
intercomCreateInternalArticle | Create an internal team knowledge article. |
intercomRetrieveInternalArticle | Fetch a single internal article by ID. |
intercomListInternalArticles | List internal articles with cursor pagination. |
intercomUpdateInternalArticle | Update an internal article title, body, author, or owner. |
intercomDeleteInternalArticle | Permanently delete an internal article. |
intercomSearchInternalArticles | Search internal articles, optionally within a folder. |
intercomCreateExternalPage | Ingest an external page into the Fin content library (upserts on source plus external ID). |
intercomGetExternalPage | Fetch an external page with content and AI availability. |
intercomListExternalPages | List external pages in the Fin content library. |
intercomUpdateExternalPage | Update an API-created external page content, metadata, or availability. |
intercomDeleteExternalPage | Delete an external page from the content library and AI answers. |
intercomCreateContentImportSource | Create a container for external pages ingested into Fin. |
intercomGetContentImportSource | Fetch a content import source by ID. |
intercomListContentImportSources | List content import sources for the workspace. |
intercomUpdateContentImportSource | Update a content import source URL, sync behavior, or status. |
intercomDeleteContentImportSource | Delete a content import source and all its external pages. Permanent. |
intercomListNewsItems | Fetch news items posted in the workspace. |
intercomCreateDataEvent | Track a user activity event with optional metadata. Duplicates are ignored. |
intercomListDataEvents | List events for a customer from the last 90 days. |
intercomCreateEventSummaries | Bulk set event counts with first/last timestamps for a user. |
intercomCreateDataAttribute | Define a custom data attribute for contacts or companies. |
intercomUpdateDataAttribute | Update a data attribute description, archive flag, or writability. |
intercomListDataAttributes | List data attributes for contacts or companies. |
intercomCreateDataExport | Start an async message-engagement data export job for a time range. |
intercomRetrieveDataExportJob | Check a data export job status and download URL. Jobs expire after two days. |
intercomCancelDataExport | Cancel an active data export job. |
intercomDownloadDataExport | Download a completed export as gzipped CSV (base64, capped). |
intercomRetrieveJobStatus | Check an async bulk job status, e.g. from enqueued ticket creation. |
intercomGetCounts | Get entity counts: app totals, conversation states, or per-tag/segment/user breakdowns. |
intercomGetCustomObjectInstance | Fetch a custom object instance by your external ID. |
intercomIdentifyAdmin | Identify the authorized admin and workspace. Start here to resolve IDs. |
intercomListAdmins | Fetch teammates with inbox seats, away state, and teams. |
intercomRetrieveAdmin | Fetch a single admin by ID. |
intercomSetAdminAway | Set an admin away, optionally reassigning new replies and giving a reason. |
intercomSetAnAdminAway | Set an admin away for the inbox with reassignment control. |
intercomListActivityLogs | Audit log of admin actions in a time window. |
intercomListAwayStatusReasons | List away status reasons including deleted ones. |
intercomListTeams | List teams with members and assignment config. |
intercomRetrieveTeam | Fetch a single team by ID. |
intercomListMacros | List saved replies (macros), newest first, with cursor pagination. |
intercomRetrieveMacro | Fetch a single saved reply by ID when visible to you. |
intercomListCalls | List phone calls with pagination. |
intercomListCallsWithTranscripts | Fetch calls with transcripts for up to 20 conversations. |
intercomShowCall | Fetch a single call with recording and transcript URLs. |
intercomShowCallTranscript | Get a call transcript as text. Long transcripts are truncated. |
intercomRegisterFinVoiceCall | Register an external voice call for Fin analysis and tracking. |
intercomCreateTag | Create or update a tag, optionally tagging users and companies. |
intercomFindTag | Fetch a tag by ID. |
intercomListTags | Fetch all workspace tags. |
intercomDeleteTag | Permanently delete a tag from the workspace. |
intercomListSegments | List segments for filtering and categorizing contacts. |
intercomRetrieveSegment | Fetch a single segment by ID with optional contact count. |
intercomListSubscriptionTypes | List subscription types with consent mode and translations. |