Connectors

Customer Support & Success

Intercom

Customer messaging: contacts, conversations, articles, and event tracking
Intercom API referenceAPI checked August 18, 2026
Signs in with
Connection fields
Runs on
Cloud or On-Prem Worker
Operations
231
Ready-made triggers
48

Connect Intercom

  1. In Neblex open Connect › Connections and click New Connection.
  2. Search for Intercom and give the connection a clear name.
  3. Fill in the fields. Secret values are encrypted and never shown again.
  4. Click Test, then Create Connection.
FieldWhat to enter
API hostRequiredChoose the Intercom API region that owns the workspace.
Access tokenRequiredSecret

Triggers

Start a flow when something changes in Intercom: add a Poll for changes trigger, choose Intercom and pick the event.

EventWhat it doesHow
New or updated companyFires for each company created or changed since the last check.Checks for changes by updated_at
New or updated contactFires for each contact created or changed since the last check.Checks for changes by updated_at
New or updated messageFires for each message created or changed since the last check.Checks for changes by updated_at
New or updated data attributeFires for each data attribute created or changed since the last check.Checks for changes by updated_at
New or updated adminFires for each admin that appears or changes since the last check.Checks for changes
New or updated help centerFires for each help center created or changed since the last check.Checks for changes by updated_at
New or updated articleFires for each article that appears or changes since the last check.Checks for changes
New or updated audienceFires for each audience created or changed since the last check.Checks for changes by updated_at
New or updated callFires for each call that appears or changes since the last check.Checks for changes
New or updated noteFires for each note that appears or changes since the last check.Checks for changes
New or updated bannerFires for each banner that appears or changes since the last check.Checks for changes
New or updated ai contentFires for each ai content created or changed since the last check.Checks for changes by updated_at
New or updated content snippetFires for each content snippet created or changed since the last check.Checks for changes by updated_at
New or updated conversations attributeFires for each conversations attribute created or changed since the last check.Checks for changes by updated_at
New or updated conversationFires for each conversation created or changed since the last check.Checks for changes by updated_at
New or updated data connectorFires for each data connector that appears or changes since the last check.Checks for changes
New or updated internal articleFires for each internal article created or changed since the last check.Checks for changes by updated_at
New or updated newsFires for each news created or changed since the last check.Checks for changes by updated_at
New or updated office hourFires for each office hour created or changed since the last check.Checks for changes by updated_at
New or updated reporting data exportFires for each reporting data export that appears or changes since the last check.Checks for changes
New or updated subscription typeFires for each subscription type that appears or changes since the last check.Checks for changes
New or updated tagFires for each tag that appears or changes since the last check.Checks for changes
New or updated ticket typeFires for each ticket type created or changed since the last check.Checks for changes by updated_at
New or updated contentFires for each content that appears or changes since the last check.Checks for changes
New companyFires for each company created since the last check.Checks for changes by created_at
New contactFires for each contact created since the last check.Checks for changes by created_at
New messageFires for each message created since the last check.Checks for changes by created_at
New data attributeFires for each data attribute created since the last check.Checks for changes by created_at
New adminFires for each admin created since the last check.Checks for changes by created_at
New help centerFires for each help center created since the last check.Checks for changes by created_at
New articleFires for each article created since the last check.Checks for changes by created_at
New audienceFires for each audience created since the last check.Checks for changes by created_at
New callFires for each call that appears since the last check.Checks for changes
New noteFires for each note created since the last check.Checks for changes by created_at
New bannerFires for each banner created since the last check.Checks for changes by created_at
New ai contentFires for each ai content created since the last check.Checks for changes by created_at
New content snippetFires for each content snippet created since the last check.Checks for changes by created_at
New conversations attributeFires for each conversations attribute created since the last check.Checks for changes by created_at
New conversationFires for each conversation created since the last check.Checks for changes by created_at
New data connectorFires for each data connector created since the last check.Checks for changes by created_at
New internal articleFires for each internal article created since the last check.Checks for changes by created_at
New newsFires for each news created since the last check.Checks for changes by created_at
New office hourFires for each office hour created since the last check.Checks for changes by created_at
New reporting data exportFires for each reporting data export that appears since the last check.Checks for changes
New subscription typeFires for each subscription type that appears since the last check.Checks for changes
New tagFires for each tag that appears since the last check.Checks for changes
New ticket typeFires for each ticket type created since the last check.Checks for changes by created_at
New contentFires for each content that appears since the last check.Checks for changes

Use it in a flow

  1. Open a flow, open the node library and search for Intercom.
  2. Drag it onto the canvas and choose an Operation and your connection.
  3. Map the operation's fields from earlier steps, or click Map with Matt.
  4. Use Test this step to see what it returns, then save.

Operations

231 operations in 42 groups. Each one is a step you can add to a flow.

Admin7
Identify an adminidentifyAdminGETYou can view the currently authorised admin along with the embedded app object (a "workspace" in legacy terminology).
List all activity log event typeslistActivityLogEventTypesGETYou can get a list of all activity log event types.
List all activity logslistActivityLogsGETYou can get a log of activities by all admins in an app.
List all adminslistAdminsGETYou can fetch a list of admins for a given workspace.
Retrieve an adminretrieveAdminGETYou can retrieve the details of a single admin.
Search activity logssearchActivityLogsPOSTSearch and filter admin activity logs using a POST request with event type filter in the request body.
Set an admin to awaysetAwayAdminPUTYou can set an Admin as away for the Inbox.
AI Content10
Create a content import sourcecreateContentImportSourcePOSTYou can create a new content import source by sending a POST request to this endpoint.
Create an external page (or update an external page by externalcreateExternalPagePOSTYou can create a new external page by sending a POST request to this endpoint.
Delete a content import sourcedeleteContentImportSourceDELETEYou can delete a content import source by making a DELETE request this endpoint.
Delete an external pagedeleteExternalPageDELETESending a DELETE request for an external page will remove it from the content library UI and from being used for AI answers.
List content import sourceslistContentImportSourcesGETYou can retrieve a list of all content import sources for a workspace.
List external pageslistExternalPagesGETYou can retrieve a list of all external pages for a workspace.
Retrieve a content import sourcegetContentImportSourceGET
Retrieve an external pagegetExternalPageGETYou can retrieve an external page.
Update a content import sourceupdateContentImportSourcePUTYou can update an existing content import source.
Update an external pageupdateExternalPagePUTYou can update an existing external page (if it was created via the API).
Article13
Add a tag to an articleattachTagToArticlePOSTApply an existing tag to an article.
Create an articlecreateArticlePOSTYou can create a new article by making a POST request to https://api.intercom.io/articles.
Delete an articledeleteArticleDELETEYou can delete a single article by making a DELETE request to https://api.intercom.io/articles/ .
List all articleslistArticlesGETYou can fetch a list of all articles by making a GET request to https://api.intercom.io/articles.
List article versionslistArticleVersionsGETFetch the version history of an article by making a GET request to https://api.intercom.io/articles/ /versions.
Publish an article draftpublishArticleDraftPOSTPublish a staged draft by making a POST request to https://api.intercom.io/articles/ /draft/publish, promoting the draft content to live.
Remove a tag from an articledetachTagFromArticleDELETERemove a tag from an article.
Retrieve an articleretrieveArticleGETYou can fetch the details of a single article by making a GET request to https://api.intercom.io/articles/ .
Retrieve an article draftretrieveArticleDraftGETFetch the staged draft of a published article by making a GET request to https://api.intercom.io/articles/ /draft.
Retrieve an article versionretrieveArticleVersionGETFetch a single prior version of an article, including its body content, by making a GET request to https://api.intercom.io/articles/ /versions/ .
Search for articlessearchArticlesGETYou can search for articles by making a GET request to https://api.intercom.io/articles/search.
Stage an article draftstageArticleDraftPUTStage changes to a published article as a draft by making a PUT request to https://api.intercom.io/articles/ /draft.
Update an articleupdateArticlePUTYou can update the details of a single article by making a PUT request to https://api.intercom.io/articles/ .
Audience5
Create an audiencecreateAudiencePOSTYou can create a new audience by making a POST request to https://api.intercom.io/audiences.
Delete an audiencedeleteAudienceDELETEYou can delete a single audience by making a DELETE request to https://api.intercom.io/audiences/{id}.
List all audienceslistAudiencesGETYou can fetch a list of all audiences for the workspace.
Retrieve an audienceretrieveAudienceGETYou can fetch the details of a single audience by making a GET request to https://api.intercom.io/audiences/{id}.
Update an audienceupdateAudiencePUTYou can update the details of a single audience by making a PUT request to https://api.intercom.io/audiences/{id}.
Away Status Reason1
List all away status reasonslistAwayStatusReasonsGETReturns a list of all away status reasons configured for the workspace, including deleted ones.
Banner2
Dismiss a banner for a contactdismissContactBannerPOSTRecords that a contact has dismissed a banner.
List banners for a contactlistContactBannersGETReturns the banners a contact currently matches, so you can display them on surfaces outside the Messenger (native mobile apps, kiosks, embedded tools).
Brand2
List all brandslistBrandsGETRetrieves all brands for the workspace, including the default brand.
Retrieve a brandretrieveBrandGETFetches a specific brand by its unique identifier
Call10
Collect Fin Voice call by external IDcollectFinVoiceCallByExternalIdGETRetrieve information about a Fin Voice call using the external call identifier.
Collect Fin Voice call by IDcollectFinVoiceCallByIdGETRetrieve information about a Fin Voice call using the external reference ID.
Collect Fin Voice call by phone numbercollectFinVoiceCallByPhoneNumberGETRetrieve information about a Fin Voice call using the phone number.
Collect Fin Voice calls by conversation IDcollectFinVoiceCallsByConversationIdGETRetrieve information about Fin Voice calls associated with a conversation.
Get a callshowCallGETRetrieve a single call by id.
Get call recording by call idshowCallRecordingGETRedirects to a signed URL for the call's recording if it exists.
Get call transcript by call idshowCallTranscriptGETReturns the transcript for the specified call as a downloadable text file.
List all callslistCallsGETRetrieve a paginated list of calls.
List calls with transcriptslistCallsWithTranscriptsPOSTRetrieve calls by a list of conversation ids and include transcripts when available.
Register a Fin Voice callregisterFinVoiceCallPOSTRegister a Fin Voice call with Intercom.
Company11
Attach a Contact to a CompanyattachContactToACompanyPOSTYou can attach a company to a single contact.
Create or Update a companycreateOrUpdateCompanyPOSTYou can create or update a company.
Delete a companydeleteCompanyDELETEDelete a single company.
Detach a contact from a companydetachContactFromACompanyDELETEYou can detach a company from a single contact.
List all companieslistAllCompaniesPOSTYou can list companies.
List attached contactsListAttachedContactsGETYou can fetch a list of all contacts that belong to a company.
List attached segments for companiesListAttachedSegmentsForCompaniesGETYou can fetch a list of all segments that belong to a company.
Retrieve a company by IDRetrieveACompanyByIdGETYou can fetch a single company.
Retrieve companiesretrieveCompanyGETYou can fetch a single company by passing in company id or name.
Scroll over all companiesscrollOverAllCompaniesGETThe list all companies functionality does not work well for huge datasets, and can result in errors and performance problems when paging deeply.
Update a companyUpdateCompanyPUTYou can update a single company using the Intercom provisioned id.
Contact16
Archive contactArchiveContactPOSTYou can archive a single contact.
Block contactBlockContactPOSTBlock a single contact.
Create contactCreateContactPOSTYou can create a new contact (ie.
Delete a contactDeleteContactDELETEYou can delete a single contact.
Get a contactShowContactGETYou can fetch the details of a single contact.
Get a contact by External IDShowContactByExternalIdGETYou can fetch the details of a single contact by external ID.
Get contact merge historyListContactMergeHistoryGETRetrieve the paginated list of contacts that have been merged into a given contact.
List all contactsListContactsGETYou can fetch a list of all contacts (ie.
List attached companies for contactlistCompaniesForAContactGETYou can fetch a list of companies that are associated to a contact.
List attached segments for contactlistSegmentsForAContactGETYou can fetch a list of segments that are associated to a contact.
List subscriptions for a contactlistSubscriptionsForAContactGETYou can fetch a list of subscription types that are attached to a contact.
List tags attached to a contactlistTagsForAContactGETYou can fetch a list of all tags that are attached to a specific contact.
Merge a lead and a userMergeContactPOSTYou can merge a contact with a role of lead into a contact with a role of user.
Search contactsSearchContactsPOSTYou can search for multiple contacts by the value of their attributes in order to fetch exactly who you want.
Unarchive contactUnarchiveContactPOSTYou can unarchive a single contact.
Update a contactUpdateContactPUTYou can update an existing contact (ie.
Content2
Run a bulk action on Knowledge Hub contentbulkContentActionsPOSTAsynchronously run a bulk action over up to 1,000 Knowledge Hub content items.
Search knowledge base contentssearchContentGETSearch the knowledge base contents - articles, snippets, external pages, uploaded files, and internal articles - using a keyword query.
Content Snippet7
Add a tag to a content snippetattachTagToContentSnippetPOSTApply an existing tag to a content snippet.
Create a content snippetcreateContentSnippetPOSTYou can create a new content snippet.
Delete a content snippetdeleteContentSnippetDELETEYou can delete a single content snippet by its id.
List all content snippetslistContentSnippetsGETYou can fetch a list of all content snippets for a workspace.
Remove a tag from a content snippetdetachTagFromContentSnippetDELETERemove a tag from a content snippet.
Retrieve a content snippetgetContentSnippetGETYou can fetch a single content snippet by its id.
Update a content snippetupdateContentSnippetPUTYou can update an existing content snippet.
Conversation16
Attach a contact to a conversationattachContactToConversationPOSTYou can add participants who are contacts to a conversation, on behalf of either another contact or an admin.
Convert a conversation to a ticketconvertConversationToTicketPOSTYou can convert a conversation to a ticket.
Creates a conversationcreateConversationPOSTYou can create a conversation that has been initiated by a contact (ie.
Delete a conversationdeleteConversationDELETE{% admonition type="warning" name="Irreversible operation" %} Deleting a conversation is permanent and cannot be reversed.
Detach a contact from a group conversationdetachContactFromConversationDELETEYou can remove participants who are contacts from a group conversation, on behalf of an admin.
List all conversationslistConversationsGETYou can fetch a list of all conversations.
List all deleted conversation IDslistDeletedConversationIdsGETList all deleted conversation IDs.
List handling eventslistHandlingEventsGETList all pause/resume events for a conversation.
List side conversationslistSideConversationsGETList side conversations for a given conversation.
Manage a conversationmanageConversationPOSTFor managing conversations you can: - Close a conversation - Snooze a conversation to reopen on a future date - Open a conversation which is snoozed or closed - Assign a conversation to...
Merge a conversationmergeConversationPOSTMerge a secondary (source) conversation into a primary (target) conversation.
Redact a conversation partredactConversationPOSTYou can redact a conversation part or the source message of a conversation (as seen in the source object).
Reply to a conversationreplyConversationPOSTYou can reply to a conversation with a message from an admin or on behalf of a contact, or with a note for admins.
Retrieve a conversationretrieveConversationGETYou can fetch the details of a single conversation.
Search conversationssearchConversationsPOSTYou can search for multiple conversations by the value of their attributes in order to fetch exactly which ones you want.
Update a conversationupdateConversationPUTYou can update an existing conversation.
Conversations Attribute8
Add an option to a list conversation attributecreateConversationAttributeOptionPOSTAdd a new option to a list-type conversation attribute.
Archive an option on a list conversation attributedeleteConversationAttributeOptionDELETEArchive a single option on a list-type conversation attribute (soft delete).
Create a conversation attributecreateConversationAttributePOSTCreate a new conversation attribute.
Delete (archive) a conversation attributedeleteConversationAttributeDELETEArchive a conversation attribute (soft delete).
Get a conversation attributegetConversationAttributeGETRetrieve a single conversation attribute by ID.
List all conversation attributeslistConversationAttributesGETYou can fetch a list of all conversation attributes for your workspace.
Update a conversation attributeupdateConversationAttributePUTUpdate an existing conversation attribute.
Update an option on a list conversation attributeupdateConversationAttributeOptionPUTUpdate the label of a single option on a list-type conversation attribute.
Custom Object Instance5
Create or Update a Custom Object InstancecreateCustomObjectInstancesPOSTCreate or update a custom object instance
Delete a Custom Object Instance by External IDdeleteCustomObjectInstancesByIdDELETEDelete a single Custom Object instance by external id.
Delete a Custom Object Instance by IDdeleteCustomObjectInstancesByExternalIdDELETEDelete a single Custom Object instance using the Intercom defined id.
Get Custom Object Instance by IDgetCustomObjectInstancesByIdGETFetch a Custom Object Instance by id.
List Custom Object InstancesgetCustomObjectInstancesByExternalIdGETList instances of a custom object type.
Data Attribute3
Create a data attributecreateDataAttributePOSTYou can create a data attributes for a contact or a company.
List all data attributeslisDataAttributesGETYou can fetch a list of all data attributes belonging to a workspace for contacts or companies.
Update a data attributeupdateDataAttributePUTYou can update a data attribute.
Data Connector7
Create a data connectorcreateDataConnectorPOSTCreate a new data connector.
Delete a data connectordeleteDataConnectorDELETEDelete an existing data connector.
List all data connectorslistDataConnectorsGETReturns a paginated list of all data connectors for the workspace, ordered by most recently updated first.
List execution results for a data connectorlistDataConnectorExecutionResultsGETRetrieve paginated execution logs for a specific data connector.
Retrieve a data connectorRetrieveDataConnectorGETYou can retrieve the full detail of a single data connector by its ID.
Retrieve an execution resultshowDataConnectorExecutionResultGETRetrieve details for a specific data connector execution result.
Update a data connectorupdateDataConnectorPATCHUpdate an existing data connector.
Data Event3
Create event summariesdataEventSummariesPOSTCreate event summaries for a user.
List all data eventslisDataEventsGET🚧 Please note that you can only 'list' events that are less than 90 days old.
Submit a data eventcreateDataEventPOSTYou will need an Access Token that has write permissions to send Events.
Data Export4
Cancel content data exportcancelDataExportPOSTYou can cancel your job
Create content data exportcreateDataExportPOSTTo create your export job, you need to send a POST request to the export endpoint https://api.intercom.io/export/content/data.
Download content data exportdownloadDataExportGETWhen a job has a status of complete, and thus a filled download url, you can download your data by hitting that provided URL, formatted like so:...
Show content data exportgetDataExportGETYou can view the status of your job by sending a GET request to the URL https://api.intercom.io/export/content/data/{job identifier} - the {job identifier} is the value returned in the...
Email2
List all email settingslistEmailsGETLists all sender email address settings for the workspace
Retrieve an email settingretrieveEmailGETFetches a specific email setting by its unique identifier
Fin Agent3
Reply to FinreplyToFinPOSTOnce Fin has returned a response to a user's message, its status will be awaiting user reply.
Start a conversation with FinstartFinConversationPOSTInitialize Fin by passing it the user's message along with conversation history and user details.
Submit a CSAT ratingsubmitFinCsatPOSTRecord a customer's satisfaction rating for a conversation, with an optional free-text remark.
Help Center11
Create a collectioncreateCollectionPOSTYou can create a new collection by making a POST request to https://api.intercom.io/help center/collections.
Create a redirectcreateHelpCenterRedirectPOSTYou can create a new URL redirect by making a POST request to https://api.intercom.io/help center/help centers/{help center id}/redirects.
Delete a collectiondeleteCollectionDELETEYou can delete a single collection by making a DELETE request to https://api.intercom.io/collections/ .
Delete a redirectdeleteHelpCenterRedirectDELETEYou can delete a single redirect by making a DELETE request to https://api.intercom.io/help center/help centers/{help center id}/redirects/{id}.
List all collectionslistAllCollectionsGETYou can fetch a list of all collections by making a GET request to https://api.intercom.io/help center/collections.
List all Help CenterslistHelpCentersGETYou can list all Help Centers by making a GET request to https://api.intercom.io/help center/help centers.
List all redirects for a help centerlistHelpCenterRedirectsGETYou can fetch a list of all URL redirects for a help center by making a GET request to https://api.intercom.io/help center/help centers/{help center id}/redirects.
Retrieve a collectionretrieveCollectionGETYou can fetch the details of a single collection by making a GET request to https://api.intercom.io/help center/collections/ .
Retrieve a Help CenterretrieveHelpCenterGETYou can fetch the details of a single Help Center by making a GET request to https://api.intercom.io/help center/help center/ .
Retrieve a redirectretrieveHelpCenterRedirectGETYou can fetch the details of a single redirect by making a GET request to https://api.intercom.io/help center/help centers/{help center id}/redirects/{id}.
Update a collectionupdateCollectionPUTYou can update the details of a single collection by making a PUT request to https://api.intercom.io/collections/ .
Internal Article8
Add a tag to an internal articleattachTagToInternalArticlePOSTApply an existing tag to an internal article.
Create an internal articlecreateInternalArticlePOSTYou can create a new internal article by making a POST request to https://api.intercom.io/internal articles.
Delete an internal articledeleteInternalArticleDELETEYou can delete a single internal article by making a DELETE request to https://api.intercom.io/internal articles/ .
List all articleslistInternalArticlesGETYou can fetch a list of all internal articles by making a GET request to https://api.intercom.io/internal articles.
Remove a tag from an internal articledetachTagFromInternalArticleDELETERemove a tag from an internal article.
Retrieve an internal articleretrieveInternalArticleGETYou can fetch the details of a single internal article by making a GET request to https://api.intercom.io/internal articles/ .
Search for internal articlessearchInternalArticlesGETYou can search for internal articles by making a GET request to https://api.intercom.io/internal articles/search.
Update an internal articleupdateInternalArticlePUTYou can update the details of a single internal article by making a PUT request to https://api.intercom.io/internal articles/ .
IP Allowlist2
Get IP allowlist settingsgetIpAllowlistGETRetrieve the current IP allowlist configuration for the workspace.
Update IP allowlist settingsupdateIpAllowlistPUTUpdate the IP allowlist configuration for the workspace.
Job1
Retrieve job statusjobsStatusGETRetrieve the status of job execution.
Macro2
List all macroslistMacrosGETYou can fetch a list of all macros (saved replies) in your workspace for use in automating responses.
Retrieve a macrogetMacroGETYou can fetch a single macro (saved reply) by its ID.
Message3
Create a messagecreateMessagePOSTYou can create a message that has been initiated by an admin.
Get statuses of all messages sent based on the specifiedgetWhatsAppMessageStatusGETRetrieves statuses of messages sent from the Outbound module.
Retrieve WhatsApp message delivery statusRetrieveWhatsAppMessageStatusGETRetrieves the delivery status of a specific WhatsApp message by its message ID.
News8
Create a news itemcreateNewsItemPOSTYou can create a news item
Delete a news itemdeleteNewsItemDELETEYou can delete a single news item.
List all live newsfeed itemslistLiveNewsfeedItemsGETYou can fetch a list of all news items that are live on a given newsfeed
List all news itemslistNewsItemsGETYou can fetch a list of all news items
List all newsfeedslistNewsfeedsGETYou can fetch a list of all newsfeeds
Retrieve a news itemretrieveNewsItemGETYou can fetch the details of a single news item.
Retrieve a newsfeedretrieveNewsfeedGETYou can fetch the details of a single newsfeed
Update a news itemupdateNewsItemPUT
Note5
Create a company notecreateCompanyNotePOSTYou can add a note to a single company.
Create a notecreateNotePOSTYou can add a note to a single contact.
List all company noteslistCompanyNotesGETYou can fetch a list of notes that are associated to a company.
List all noteslistNotesGETYou can fetch a list of notes that are associated to a contact.
Retrieve a noteretrieveNoteGETYou can fetch the details of a single note.
Office Hour10
Create an office hours exceptioncreateOfficeHoursExceptionPOSTYou can create an exception for an office hours schedule.
Create an office hours schedulecreateOfficeHoursSchedulePOSTYou can create a new office hours schedule for the workspace.
Delete an office hours exceptiondeleteOfficeHoursExceptionDELETEYou can delete a single office hours exception.
Delete an office hours scheduledeleteOfficeHoursScheduleDELETEYou can delete a single office hours schedule.
List all office hours exceptionslistOfficeHoursExceptionsGETYou can fetch a list of all exceptions for an office hours schedule.
List all office hours scheduleslistOfficeHoursSchedulesGETYou can fetch a list of all office hours schedules for the workspace.
Retrieve an office hours exceptiongetOfficeHoursExceptionGETYou can fetch the details of a single office hours exception.
Retrieve an office hours schedulegetOfficeHoursScheduleGETYou can fetch the details of a single office hours schedule.
Update an office hours exceptionupdateOfficeHoursExceptionPUTYou can update an existing office hours exception.
Update an office hours scheduleupdateOfficeHoursSchedulePUTYou can update an existing office hours schedule.
Reporting Data Export4
Download completed export job datadownloadReportingDataExportGETDownload the data from a completed reporting data export job.
Enqueue a new reporting data export jobenqueueReportingDataExportPOSTFor the conversation dataset, from this version onward this export returns all conversations, including those that never received a user reply.
Get export job statusgetReportingDataExportJobGET
List available datasets and attributeslistReportingDatasetsGET
Segment2
List all segmentslistSegmentsGETYou can fetch a list of all segments.
Retrieve a segmentretrieveSegmentGETYou can fetch the details of a single segment.
Subscription Type3
Add subscription to a contactattachSubscriptionTypeToContactPOSTYou can add a specific subscription to a contact.
List subscription typeslistSubscriptionTypesGETYou can list all subscription types.
Remove subscription from a contactdetachSubscriptionTypeToContactDELETEYou can remove a specific subscription from a contact.
Switch1
Create a phone SwitchcreatePhoneSwitchPOSTYou can use the API to deflect phone calls to the Intercom Messenger.
Tag10
Add tag to a contactattachTagToContactPOSTYou can tag a specific contact.
Add tag to a conversationattachTagToConversationPOSTYou can tag a specific conversation.
Add tag to a ticketattachTagToTicketPOSTYou can tag a specific ticket.
Create or update a tag, Tag or untag companies, Tag contactscreateTagPOSTYou can use this endpoint to perform the following operations:
Delete tagdeleteTagDELETEYou can delete the details of tags that are on the workspace by passing in the id.
Find a specific tagfindTagGETYou can fetch the details of tags that are on the workspace by their id.
List all tagslistTagsGETYou can fetch a list of all tags for a given workspace.
Remove tag from a contactdetachTagFromContactDELETEYou can remove tag from a specific contact.
Remove tag from a conversationdetachTagFromConversationDELETEYou can remove tag from a specific conversation.
Remove tag from a ticketdetachTagFromTicketDELETEYou can remove tag from a specific ticket.
Team3
List all teamslistTeamsGETThis will return a list of team objects for the App.
Retrieve a teamretrieveTeamGETYou can fetch the details of a single team, containing an array of admins that belong to this team.
Retrieve team metricsgetTeamMetricsGETReturns real-time activity metrics for admins in the specified team.
Ticket10
Change ticket typechangeTicketTypePOSTYou can change the type of a ticket.
Create a ticketcreateTicketPOSTYou can create a new ticket.
Delete a ticketdeleteTicketDELETE{% admonition type="warning" name="Irreversible operation" %} Deleting a ticket is permanent and cannot be reversed.
Enqueue create ticketenqueueCreateTicketPOSTEnqueues ticket creation for asynchronous processing, returning if the job was enqueued successfully to be processed.
Link a conversation to a ticketlinkConversationToTicketPOSTLink a conversation to an existing tracker ticket.
Reply to a ticketreplyTicketPOSTYou can reply to a ticket with a message from an admin or on behalf of a contact, or with a note for admins.
Retrieve a ticketgetTicketGETYou can fetch the details of a single ticket.
Search ticketssearchTicketsPOSTYou can search for multiple tickets by the value of their attributes in order to fetch exactly which ones you want.
Unlink a conversation from a ticketunlinkConversationFromTicketDELETEUnlink a conversation (or converted customer ticket) from a tracker ticket it is currently linked to.
Update a ticketupdateTicketPUTYou can update a ticket.
Ticket State1
List all ticket stateslistTicketStatesGETYou can get a list of all ticket states for a workspace.
Ticket Type4
Create a ticket typecreateTicketTypePOSTYou can create a new ticket type.
List all ticket typeslistTicketTypesGETYou can get a list of all ticket types for a workspace.
Retrieve a ticket typegetTicketTypeGETYou can fetch the details of a single ticket type.
Update a ticket typeupdateTicketTypePUTYou can update a ticket type.
Ticket Type Attribute2
Create a new attribute for a ticket typecreateTicketTypeAttributePOSTYou can create a new attribute for a ticket type.
Update an existing attribute for a ticket typeupdateTicketTypeAttributePUTYou can update an existing attribute for a ticket type.
Visitor3
Convert a visitorconvertVisitorPOSTYou can merge a Visitor to a Contact of role type lead or user.
Retrieve a visitor with User IDretrieveVisitorWithUserIdGETYou can fetch the details of a single visitor.
Update a visitorupdateVisitorPUTSending a PUT request to /visitors will result in an update of an existing Visitor.
Workflow1
Export a workflowexportWorkflowGETExport a workflow configuration by its ID.