Docs · static mirror — the interactive version loads with JavaScript.

Intercom

Source: https://runstack.engineer/docs/toolkits/intercom

Manage contacts, companies, conversations, tickets, articles, and events via the Intercom API v2.

Tools (133):

ToolDescription
intercomCreateContactCreate a new contact (user or lead) in the Intercom workspace.
intercomGetContactFetch the details of a single contact by Intercom ID.
intercomUpdateContactAUpdate a contact by Intercom ID, optionally attaching companies afterwards.
intercomUpdateContactUpdate a contact name, email, role, attributes, or subscription flags.
intercomDeleteContactPermanently delete a contact from the Intercom workspace.
intercomArchiveContactArchive a single contact by ID.
intercomUnarchiveContactUnarchive (restore) a previously archived contact by ID.
intercomBlockContactBlock a contact; their conversations are archived too.
intercomMergeLeadAndUserMerge a lead contact into a user contact. The lead is permanently removed.
intercomSearchContactsSearch contacts with field/operator filters, e.g. role equals user.
intercomListContactsList all contacts (users and leads) with cursor pagination.
intercomShowContactByExternalIdFetch a contact by your external ID. Users only, not leads.
intercomDeleteVisitorPermanently delete a visitor record from the workspace.
intercomRetrieveVisitorFetch a visitor profile, location, and activity by your user ID.
intercomCreateNoteAdd a note to a single contact.
intercomListNotesFetch notes associated with a contact.
intercomRetrieveNoteFetch a single note by note ID.
intercomAttachContactToCompanyAssociate a contact with a company.
intercomDetachContactFromCompanyRemove a company association from a contact.
intercomListContactCompaniesFetch companies associated with a contact.
intercomListContactSegmentsFetch segments associated with a contact.
intercomAddTagToContactAttach a tag to a contact for categorization.
intercomDetachContactFromTagRemove a tag from a contact.
intercomRemoveTagFromContactRemove a tag from a specific contact, returning the removed tag.
intercomListContactTagsFetch all tags attached to a contact.
intercomAddContactSubscriptionOpt a contact in or out of a subscription type.
intercomRemoveContactSubscriptionRemove a subscription type from a contact.
intercomListContactSubscriptionsFetch opted-in and opted-out subscription types for a contact.
intercomCreateOrUpdateCompanyCreate a company by company_id, or update it when it already exists.
intercomRetrieveCompaniesFetch companies filtered by name, company_id, tag, or segment.
intercomRetrieveCompanyByIdFetch a single company by Intercom ID.
intercomUpdateCompanyUpdate a company by Intercom ID. company_id cannot be changed.
intercomDeleteCompanyDelete a single company.
intercomListCompaniesList companies sorted by recent activity, paginated.
intercomScrollCompaniesIterate all companies efficiently via the scroll API for huge datasets.
intercomListCompanyContactsFetch all contacts belonging to a company.
intercomListCompanySegmentsFetch segments that a company belongs to.
intercomListCompanyNotesFetch notes added to a company record.
intercomCreateConversationStart a contact-initiated style conversation with a message from a user or contact.
intercomGetConversationRetrieve a conversation with messages and details. Prefer this for full context.
intercomListConversationsList conversations with cursor pagination. No filtering; use search instead.
intercomSearchConversationsSearch conversations by state, dates, assignees, tags, and more.
intercomReplyToConversationSend an admin reply (comment or note) to a conversation. Reply before closing.
intercomCloseConversationClose (resolve) a conversation, optionally with a closing message.
intercomReopenConversationReopen a closed conversation, optionally with a message.
intercomAssignConversationAssign a conversation to an admin or a team.
intercomAttachContactToConversationAdd a contact participant to a conversation as an admin.
intercomAttachTagToConversationAttach a tag to a conversation.
intercomDetachTagFromConversationRemove a tag from a conversation.
intercomCreateTicketCreate a support ticket for contacts with type, attributes, and assignment.
intercomEnqueueCreateTicketEnqueue ticket creation for async processing with validation first.
intercomGetTicketFetch a ticket with state, type, attributes, and contacts.
intercomUpdateTicketUpdate ticket attributes, state, assignment, sharing, or snooze.
intercomDeleteTicketPermanently delete a ticket.
intercomSearchTicketsSearch tickets by state, dates, assignees, or custom attributes.
intercomReplyTicketReply to a ticket as an admin (comment/note) or on behalf of a contact.
intercomCreateTicketTypeCreate a ticket type defining structure and workflow for tickets.
intercomGetTicketTypeFetch a ticket type with attributes and states.
intercomListTicketTypesList all ticket types in the workspace.
intercomUpdateTicketTypeUpdate a ticket type name, description, category, icon, or archive flag.
intercomCreateTicketTypeAttributeAdd a custom attribute field to a ticket type.
intercomUpdateTicketTypeAttributeUpdate a ticket type attribute description, visibility, or requirements.
intercomListTicketStatesFetch all ticket states including archived ones.
intercomAttachTagToTicketAttach a tag to a ticket.
intercomDetachTagFromTicketRemove a tag from a ticket.
intercomCreateCollectionCreate a help center collection, optionally nested or translated.
intercomRetrieveCollectionFetch a single help center collection by ID.
intercomListCollectionsList help center collections, most recently updated first.
intercomUpdateCollectionUpdate a help center collection name, description, or parent.
intercomDeleteCollectionDelete a help center collection.
intercomCreateHelpCenterSectionCreate a help center section inside a collection for organizing articles.
intercomListHelpCenterSectionsList help center sections, most recently updated first.
intercomListHelpCentersList all help centers in the workspace.
intercomRetrieveHelpCenterFetch a single help center by ID.
intercomCreateArticleCreate a help center article as draft or published.
intercomRetrieveArticleFetch a single article with statistics.
intercomListArticlesList articles, most recently updated first.
intercomUpdateArticleUpdate an article title, body, state, author, or parent.
intercomDeleteArticleDelete a single article.
intercomSearchArticlesSearch articles by phrase, state, and help center.
intercomCreateInternalArticleCreate an internal team knowledge article.
intercomRetrieveInternalArticleFetch a single internal article by ID.
intercomListInternalArticlesList internal articles with cursor pagination.
intercomUpdateInternalArticleUpdate an internal article title, body, author, or owner.
intercomDeleteInternalArticlePermanently delete an internal article.
intercomSearchInternalArticlesSearch internal articles, optionally within a folder.
intercomCreateExternalPageIngest an external page into the Fin content library (upserts on source plus external ID).
intercomGetExternalPageFetch an external page with content and AI availability.
intercomListExternalPagesList external pages in the Fin content library.
intercomUpdateExternalPageUpdate an API-created external page content, metadata, or availability.
intercomDeleteExternalPageDelete an external page from the content library and AI answers.
intercomCreateContentImportSourceCreate a container for external pages ingested into Fin.
intercomGetContentImportSourceFetch a content import source by ID.
intercomListContentImportSourcesList content import sources for the workspace.
intercomUpdateContentImportSourceUpdate a content import source URL, sync behavior, or status.
intercomDeleteContentImportSourceDelete a content import source and all its external pages. Permanent.
intercomListNewsItemsFetch news items posted in the workspace.
intercomCreateDataEventTrack a user activity event with optional metadata. Duplicates are ignored.
intercomListDataEventsList events for a customer from the last 90 days.
intercomCreateEventSummariesBulk set event counts with first/last timestamps for a user.
intercomCreateDataAttributeDefine a custom data attribute for contacts or companies.
intercomUpdateDataAttributeUpdate a data attribute description, archive flag, or writability.
intercomListDataAttributesList data attributes for contacts or companies.
intercomCreateDataExportStart an async message-engagement data export job for a time range.
intercomRetrieveDataExportJobCheck a data export job status and download URL. Jobs expire after two days.
intercomCancelDataExportCancel an active data export job.
intercomDownloadDataExportDownload a completed export as gzipped CSV (base64, capped).
intercomRetrieveJobStatusCheck an async bulk job status, e.g. from enqueued ticket creation.
intercomGetCountsGet entity counts: app totals, conversation states, or per-tag/segment/user breakdowns.
intercomGetCustomObjectInstanceFetch a custom object instance by your external ID.
intercomIdentifyAdminIdentify the authorized admin and workspace. Start here to resolve IDs.
intercomListAdminsFetch teammates with inbox seats, away state, and teams.
intercomRetrieveAdminFetch a single admin by ID.
intercomSetAdminAwaySet an admin away, optionally reassigning new replies and giving a reason.
intercomSetAnAdminAwaySet an admin away for the inbox with reassignment control.
intercomListActivityLogsAudit log of admin actions in a time window.
intercomListAwayStatusReasonsList away status reasons including deleted ones.
intercomListTeamsList teams with members and assignment config.
intercomRetrieveTeamFetch a single team by ID.
intercomListMacrosList saved replies (macros), newest first, with cursor pagination.
intercomRetrieveMacroFetch a single saved reply by ID when visible to you.
intercomListCallsList phone calls with pagination.
intercomListCallsWithTranscriptsFetch calls with transcripts for up to 20 conversations.
intercomShowCallFetch a single call with recording and transcript URLs.
intercomShowCallTranscriptGet a call transcript as text. Long transcripts are truncated.
intercomRegisterFinVoiceCallRegister an external voice call for Fin analysis and tracking.
intercomCreateTagCreate or update a tag, optionally tagging users and companies.
intercomFindTagFetch a tag by ID.
intercomListTagsFetch all workspace tags.
intercomDeleteTagPermanently delete a tag from the workspace.
intercomListSegmentsList segments for filtering and categorizing contacts.
intercomRetrieveSegmentFetch a single segment by ID with optional contact count.
intercomListSubscriptionTypesList subscription types with consent mode and translations.