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
- In Neblex open Connect › Connections and click New Connection.
- Search for Intercom and give the connection a clear name.
- Fill in the fields. Secret values are encrypted and never shown again.
- Click Test, then Create Connection.
| Field | What to enter |
|---|---|
| API hostRequired | Choose 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.
| Event | What it does | How |
|---|---|---|
| New or updated company | Fires for each company created or changed since the last check. | Checks for changes by updated_at |
| New or updated contact | Fires for each contact created or changed since the last check. | Checks for changes by updated_at |
| New or updated message | Fires for each message created or changed since the last check. | Checks for changes by updated_at |
| New or updated data attribute | Fires for each data attribute created or changed since the last check. | Checks for changes by updated_at |
| New or updated admin | Fires for each admin that appears or changes since the last check. | Checks for changes |
| New or updated help center | Fires for each help center created or changed since the last check. | Checks for changes by updated_at |
| New or updated article | Fires for each article that appears or changes since the last check. | Checks for changes |
| New or updated audience | Fires for each audience created or changed since the last check. | Checks for changes by updated_at |
| New or updated call | Fires for each call that appears or changes since the last check. | Checks for changes |
| New or updated note | Fires for each note that appears or changes since the last check. | Checks for changes |
| New or updated banner | Fires for each banner that appears or changes since the last check. | Checks for changes |
| New or updated ai content | Fires for each ai content created or changed since the last check. | Checks for changes by updated_at |
| New or updated content snippet | Fires for each content snippet created or changed since the last check. | Checks for changes by updated_at |
| New or updated conversations attribute | Fires for each conversations attribute created or changed since the last check. | Checks for changes by updated_at |
| New or updated conversation | Fires for each conversation created or changed since the last check. | Checks for changes by updated_at |
| New or updated data connector | Fires for each data connector that appears or changes since the last check. | Checks for changes |
| New or updated internal article | Fires for each internal article created or changed since the last check. | Checks for changes by updated_at |
| New or updated news | Fires for each news created or changed since the last check. | Checks for changes by updated_at |
| New or updated office hour | Fires for each office hour created or changed since the last check. | Checks for changes by updated_at |
| New or updated reporting data export | Fires for each reporting data export that appears or changes since the last check. | Checks for changes |
| New or updated subscription type | Fires for each subscription type that appears or changes since the last check. | Checks for changes |
| New or updated tag | Fires for each tag that appears or changes since the last check. | Checks for changes |
| New or updated ticket type | Fires for each ticket type created or changed since the last check. | Checks for changes by updated_at |
| New or updated content | Fires for each content that appears or changes since the last check. | Checks for changes |
| New company | Fires for each company created since the last check. | Checks for changes by created_at |
| New contact | Fires for each contact created since the last check. | Checks for changes by created_at |
| New message | Fires for each message created since the last check. | Checks for changes by created_at |
| New data attribute | Fires for each data attribute created since the last check. | Checks for changes by created_at |
| New admin | Fires for each admin created since the last check. | Checks for changes by created_at |
| New help center | Fires for each help center created since the last check. | Checks for changes by created_at |
| New article | Fires for each article created since the last check. | Checks for changes by created_at |
| New audience | Fires for each audience created since the last check. | Checks for changes by created_at |
| New call | Fires for each call that appears since the last check. | Checks for changes |
| New note | Fires for each note created since the last check. | Checks for changes by created_at |
| New banner | Fires for each banner created since the last check. | Checks for changes by created_at |
| New ai content | Fires for each ai content created since the last check. | Checks for changes by created_at |
| New content snippet | Fires for each content snippet created since the last check. | Checks for changes by created_at |
| New conversations attribute | Fires for each conversations attribute created since the last check. | Checks for changes by created_at |
| New conversation | Fires for each conversation created since the last check. | Checks for changes by created_at |
| New data connector | Fires for each data connector created since the last check. | Checks for changes by created_at |
| New internal article | Fires for each internal article created since the last check. | Checks for changes by created_at |
| New news | Fires for each news created since the last check. | Checks for changes by created_at |
| New office hour | Fires for each office hour created since the last check. | Checks for changes by created_at |
| New reporting data export | Fires for each reporting data export that appears since the last check. | Checks for changes |
| New subscription type | Fires for each subscription type that appears since the last check. | Checks for changes |
| New tag | Fires for each tag that appears since the last check. | Checks for changes |
| New ticket type | Fires for each ticket type created since the last check. | Checks for changes by created_at |
| New content | Fires for each content that appears since the last check. | Checks for changes |
Use it in a flow
- Open a flow, open the node library and search for Intercom.
- Drag it onto the canvas and choose an Operation and your connection.
- Map the operation's fields from earlier steps, or click Map with Matt.
- 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 adminidentifyAdmin | GET | You can view the currently authorised admin along with the embedded app object (a "workspace" in legacy terminology). |
List all activity log event typeslistActivityLogEventTypes | GET | You can get a list of all activity log event types. |
List all activity logslistActivityLogs | GET | You can get a log of activities by all admins in an app. |
List all adminslistAdmins | GET | You can fetch a list of admins for a given workspace. |
Retrieve an adminretrieveAdmin | GET | You can retrieve the details of a single admin. |
Search activity logssearchActivityLogs | POST | Search and filter admin activity logs using a POST request with event type filter in the request body. |
Set an admin to awaysetAwayAdmin | PUT | You can set an Admin as away for the Inbox. |
AI Content10
Create a content import sourcecreateContentImportSource | POST | You 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 externalcreateExternalPage | POST | You can create a new external page by sending a POST request to this endpoint. |
Delete a content import sourcedeleteContentImportSource | DELETE | You can delete a content import source by making a DELETE request this endpoint. |
Delete an external pagedeleteExternalPage | DELETE | Sending 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 sourceslistContentImportSources | GET | You can retrieve a list of all content import sources for a workspace. |
List external pageslistExternalPages | GET | You can retrieve a list of all external pages for a workspace. |
Retrieve a content import sourcegetContentImportSource | GET | |
Retrieve an external pagegetExternalPage | GET | You can retrieve an external page. |
Update a content import sourceupdateContentImportSource | PUT | You can update an existing content import source. |
Update an external pageupdateExternalPage | PUT | You can update an existing external page (if it was created via the API). |
Article13
Add a tag to an articleattachTagToArticle | POST | Apply an existing tag to an article. |
Create an articlecreateArticle | POST | You can create a new article by making a POST request to https://api.intercom.io/articles. |
Delete an articledeleteArticle | DELETE | You can delete a single article by making a DELETE request to https://api.intercom.io/articles/ . |
List all articleslistArticles | GET | You can fetch a list of all articles by making a GET request to https://api.intercom.io/articles. |
List article versionslistArticleVersions | GET | Fetch the version history of an article by making a GET request to https://api.intercom.io/articles/ /versions. |
Publish an article draftpublishArticleDraft | POST | Publish 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 articledetachTagFromArticle | DELETE | Remove a tag from an article. |
Retrieve an articleretrieveArticle | GET | You can fetch the details of a single article by making a GET request to https://api.intercom.io/articles/ . |
Retrieve an article draftretrieveArticleDraft | GET | Fetch the staged draft of a published article by making a GET request to https://api.intercom.io/articles/ /draft. |
Retrieve an article versionretrieveArticleVersion | GET | Fetch 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 articlessearchArticles | GET | You can search for articles by making a GET request to https://api.intercom.io/articles/search. |
Stage an article draftstageArticleDraft | PUT | Stage changes to a published article as a draft by making a PUT request to https://api.intercom.io/articles/ /draft. |
Update an articleupdateArticle | PUT | You can update the details of a single article by making a PUT request to https://api.intercom.io/articles/ . |
Audience5
Create an audiencecreateAudience | POST | You can create a new audience by making a POST request to https://api.intercom.io/audiences. |
Delete an audiencedeleteAudience | DELETE | You can delete a single audience by making a DELETE request to https://api.intercom.io/audiences/{id}. |
List all audienceslistAudiences | GET | You can fetch a list of all audiences for the workspace. |
Retrieve an audienceretrieveAudience | GET | You can fetch the details of a single audience by making a GET request to https://api.intercom.io/audiences/{id}. |
Update an audienceupdateAudience | PUT | You 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 reasonslistAwayStatusReasons | GET | Returns a list of all away status reasons configured for the workspace, including deleted ones. |
Banner2
Dismiss a banner for a contactdismissContactBanner | POST | Records that a contact has dismissed a banner. |
List banners for a contactlistContactBanners | GET | Returns 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 brandslistBrands | GET | Retrieves all brands for the workspace, including the default brand. |
Retrieve a brandretrieveBrand | GET | Fetches a specific brand by its unique identifier |
Call10
Collect Fin Voice call by external IDcollectFinVoiceCallByExternalId | GET | Retrieve information about a Fin Voice call using the external call identifier. |
Collect Fin Voice call by IDcollectFinVoiceCallById | GET | Retrieve information about a Fin Voice call using the external reference ID. |
Collect Fin Voice call by phone numbercollectFinVoiceCallByPhoneNumber | GET | Retrieve information about a Fin Voice call using the phone number. |
Collect Fin Voice calls by conversation IDcollectFinVoiceCallsByConversationId | GET | Retrieve information about Fin Voice calls associated with a conversation. |
Get a callshowCall | GET | Retrieve a single call by id. |
Get call recording by call idshowCallRecording | GET | Redirects to a signed URL for the call's recording if it exists. |
Get call transcript by call idshowCallTranscript | GET | Returns the transcript for the specified call as a downloadable text file. |
List all callslistCalls | GET | Retrieve a paginated list of calls. |
List calls with transcriptslistCallsWithTranscripts | POST | Retrieve calls by a list of conversation ids and include transcripts when available. |
Register a Fin Voice callregisterFinVoiceCall | POST | Register a Fin Voice call with Intercom. |
Company11
Attach a Contact to a CompanyattachContactToACompany | POST | You can attach a company to a single contact. |
Create or Update a companycreateOrUpdateCompany | POST | You can create or update a company. |
Delete a companydeleteCompany | DELETE | Delete a single company. |
Detach a contact from a companydetachContactFromACompany | DELETE | You can detach a company from a single contact. |
List all companieslistAllCompanies | POST | You can list companies. |
List attached contactsListAttachedContacts | GET | You can fetch a list of all contacts that belong to a company. |
List attached segments for companiesListAttachedSegmentsForCompanies | GET | You can fetch a list of all segments that belong to a company. |
Retrieve a company by IDRetrieveACompanyById | GET | You can fetch a single company. |
Retrieve companiesretrieveCompany | GET | You can fetch a single company by passing in company id or name. |
Scroll over all companiesscrollOverAllCompanies | GET | The list all companies functionality does not work well for huge datasets, and can result in errors and performance problems when paging deeply. |
Update a companyUpdateCompany | PUT | You can update a single company using the Intercom provisioned id. |
Contact16
Archive contactArchiveContact | POST | You can archive a single contact. |
Block contactBlockContact | POST | Block a single contact. |
Create contactCreateContact | POST | You can create a new contact (ie. |
Delete a contactDeleteContact | DELETE | You can delete a single contact. |
Get a contactShowContact | GET | You can fetch the details of a single contact. |
Get a contact by External IDShowContactByExternalId | GET | You can fetch the details of a single contact by external ID. |
Get contact merge historyListContactMergeHistory | GET | Retrieve the paginated list of contacts that have been merged into a given contact. |
List all contactsListContacts | GET | You can fetch a list of all contacts (ie. |
List attached companies for contactlistCompaniesForAContact | GET | You can fetch a list of companies that are associated to a contact. |
List attached segments for contactlistSegmentsForAContact | GET | You can fetch a list of segments that are associated to a contact. |
List subscriptions for a contactlistSubscriptionsForAContact | GET | You can fetch a list of subscription types that are attached to a contact. |
List tags attached to a contactlistTagsForAContact | GET | You can fetch a list of all tags that are attached to a specific contact. |
Merge a lead and a userMergeContact | POST | You can merge a contact with a role of lead into a contact with a role of user. |
Search contactsSearchContacts | POST | You can search for multiple contacts by the value of their attributes in order to fetch exactly who you want. |
Unarchive contactUnarchiveContact | POST | You can unarchive a single contact. |
Update a contactUpdateContact | PUT | You can update an existing contact (ie. |
Content2
Run a bulk action on Knowledge Hub contentbulkContentActions | POST | Asynchronously run a bulk action over up to 1,000 Knowledge Hub content items. |
Search knowledge base contentssearchContent | GET | Search 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 snippetattachTagToContentSnippet | POST | Apply an existing tag to a content snippet. |
Create a content snippetcreateContentSnippet | POST | You can create a new content snippet. |
Delete a content snippetdeleteContentSnippet | DELETE | You can delete a single content snippet by its id. |
List all content snippetslistContentSnippets | GET | You can fetch a list of all content snippets for a workspace. |
Remove a tag from a content snippetdetachTagFromContentSnippet | DELETE | Remove a tag from a content snippet. |
Retrieve a content snippetgetContentSnippet | GET | You can fetch a single content snippet by its id. |
Update a content snippetupdateContentSnippet | PUT | You can update an existing content snippet. |
Conversation16
Attach a contact to a conversationattachContactToConversation | POST | You can add participants who are contacts to a conversation, on behalf of either another contact or an admin. |
Convert a conversation to a ticketconvertConversationToTicket | POST | You can convert a conversation to a ticket. |
Creates a conversationcreateConversation | POST | You can create a conversation that has been initiated by a contact (ie. |
Delete a conversationdeleteConversation | DELETE | {% admonition type="warning" name="Irreversible operation" %} Deleting a conversation is permanent and cannot be reversed. |
Detach a contact from a group conversationdetachContactFromConversation | DELETE | You can remove participants who are contacts from a group conversation, on behalf of an admin. |
List all conversationslistConversations | GET | You can fetch a list of all conversations. |
List all deleted conversation IDslistDeletedConversationIds | GET | List all deleted conversation IDs. |
List handling eventslistHandlingEvents | GET | List all pause/resume events for a conversation. |
List side conversationslistSideConversations | GET | List side conversations for a given conversation. |
Manage a conversationmanageConversation | POST | For 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 conversationmergeConversation | POST | Merge a secondary (source) conversation into a primary (target) conversation. |
Redact a conversation partredactConversation | POST | You can redact a conversation part or the source message of a conversation (as seen in the source object). |
Reply to a conversationreplyConversation | POST | You 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 conversationretrieveConversation | GET | You can fetch the details of a single conversation. |
Search conversationssearchConversations | POST | You can search for multiple conversations by the value of their attributes in order to fetch exactly which ones you want. |
Update a conversationupdateConversation | PUT | You can update an existing conversation. |
Conversations Attribute8
Add an option to a list conversation attributecreateConversationAttributeOption | POST | Add a new option to a list-type conversation attribute. |
Archive an option on a list conversation attributedeleteConversationAttributeOption | DELETE | Archive a single option on a list-type conversation attribute (soft delete). |
Create a conversation attributecreateConversationAttribute | POST | Create a new conversation attribute. |
Delete (archive) a conversation attributedeleteConversationAttribute | DELETE | Archive a conversation attribute (soft delete). |
Get a conversation attributegetConversationAttribute | GET | Retrieve a single conversation attribute by ID. |
List all conversation attributeslistConversationAttributes | GET | You can fetch a list of all conversation attributes for your workspace. |
Update a conversation attributeupdateConversationAttribute | PUT | Update an existing conversation attribute. |
Update an option on a list conversation attributeupdateConversationAttributeOption | PUT | Update the label of a single option on a list-type conversation attribute. |
Custom Object Instance5
Create or Update a Custom Object InstancecreateCustomObjectInstances | POST | Create or update a custom object instance |
Delete a Custom Object Instance by External IDdeleteCustomObjectInstancesById | DELETE | Delete a single Custom Object instance by external id. |
Delete a Custom Object Instance by IDdeleteCustomObjectInstancesByExternalId | DELETE | Delete a single Custom Object instance using the Intercom defined id. |
Get Custom Object Instance by IDgetCustomObjectInstancesById | GET | Fetch a Custom Object Instance by id. |
List Custom Object InstancesgetCustomObjectInstancesByExternalId | GET | List instances of a custom object type. |
Data Attribute3
Create a data attributecreateDataAttribute | POST | You can create a data attributes for a contact or a company. |
List all data attributeslisDataAttributes | GET | You can fetch a list of all data attributes belonging to a workspace for contacts or companies. |
Update a data attributeupdateDataAttribute | PUT | You can update a data attribute. |
Data Connector7
Create a data connectorcreateDataConnector | POST | Create a new data connector. |
Delete a data connectordeleteDataConnector | DELETE | Delete an existing data connector. |
List all data connectorslistDataConnectors | GET | Returns a paginated list of all data connectors for the workspace, ordered by most recently updated first. |
List execution results for a data connectorlistDataConnectorExecutionResults | GET | Retrieve paginated execution logs for a specific data connector. |
Retrieve a data connectorRetrieveDataConnector | GET | You can retrieve the full detail of a single data connector by its ID. |
Retrieve an execution resultshowDataConnectorExecutionResult | GET | Retrieve details for a specific data connector execution result. |
Update a data connectorupdateDataConnector | PATCH | Update an existing data connector. |
Data Event3
Create event summariesdataEventSummaries | POST | Create event summaries for a user. |
List all data eventslisDataEvents | GET | 🚧 Please note that you can only 'list' events that are less than 90 days old. |
Submit a data eventcreateDataEvent | POST | You will need an Access Token that has write permissions to send Events. |
Data Export4
Cancel content data exportcancelDataExport | POST | You can cancel your job |
Create content data exportcreateDataExport | POST | To 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 exportdownloadDataExport | GET | When 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 exportgetDataExport | GET | You 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 settingslistEmails | GET | Lists all sender email address settings for the workspace |
Retrieve an email settingretrieveEmail | GET | Fetches a specific email setting by its unique identifier |
Fin Agent3
Reply to FinreplyToFin | POST | Once Fin has returned a response to a user's message, its status will be awaiting user reply. |
Start a conversation with FinstartFinConversation | POST | Initialize Fin by passing it the user's message along with conversation history and user details. |
Submit a CSAT ratingsubmitFinCsat | POST | Record a customer's satisfaction rating for a conversation, with an optional free-text remark. |
Help Center11
Create a collectioncreateCollection | POST | You can create a new collection by making a POST request to https://api.intercom.io/help center/collections. |
Create a redirectcreateHelpCenterRedirect | POST | You 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 collectiondeleteCollection | DELETE | You can delete a single collection by making a DELETE request to https://api.intercom.io/collections/ . |
Delete a redirectdeleteHelpCenterRedirect | DELETE | You 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 collectionslistAllCollections | GET | You can fetch a list of all collections by making a GET request to https://api.intercom.io/help center/collections. |
List all Help CenterslistHelpCenters | GET | You 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 centerlistHelpCenterRedirects | GET | You 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 collectionretrieveCollection | GET | You can fetch the details of a single collection by making a GET request to https://api.intercom.io/help center/collections/ . |
Retrieve a Help CenterretrieveHelpCenter | GET | You 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 redirectretrieveHelpCenterRedirect | GET | You 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 collectionupdateCollection | PUT | You 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 articleattachTagToInternalArticle | POST | Apply an existing tag to an internal article. |
Create an internal articlecreateInternalArticle | POST | You can create a new internal article by making a POST request to https://api.intercom.io/internal articles. |
Delete an internal articledeleteInternalArticle | DELETE | You can delete a single internal article by making a DELETE request to https://api.intercom.io/internal articles/ . |
List all articleslistInternalArticles | GET | You 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 articledetachTagFromInternalArticle | DELETE | Remove a tag from an internal article. |
Retrieve an internal articleretrieveInternalArticle | GET | You can fetch the details of a single internal article by making a GET request to https://api.intercom.io/internal articles/ . |
Search for internal articlessearchInternalArticles | GET | You can search for internal articles by making a GET request to https://api.intercom.io/internal articles/search. |
Update an internal articleupdateInternalArticle | PUT | You 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 settingsgetIpAllowlist | GET | Retrieve the current IP allowlist configuration for the workspace. |
Update IP allowlist settingsupdateIpAllowlist | PUT | Update the IP allowlist configuration for the workspace. |
Job1
Retrieve job statusjobsStatus | GET | Retrieve the status of job execution. |
Macro2
List all macroslistMacros | GET | You can fetch a list of all macros (saved replies) in your workspace for use in automating responses. |
Retrieve a macrogetMacro | GET | You can fetch a single macro (saved reply) by its ID. |
Message3
Create a messagecreateMessage | POST | You can create a message that has been initiated by an admin. |
Get statuses of all messages sent based on the specifiedgetWhatsAppMessageStatus | GET | Retrieves statuses of messages sent from the Outbound module. |
Retrieve WhatsApp message delivery statusRetrieveWhatsAppMessageStatus | GET | Retrieves the delivery status of a specific WhatsApp message by its message ID. |
News8
Create a news itemcreateNewsItem | POST | You can create a news item |
Delete a news itemdeleteNewsItem | DELETE | You can delete a single news item. |
List all live newsfeed itemslistLiveNewsfeedItems | GET | You can fetch a list of all news items that are live on a given newsfeed |
List all news itemslistNewsItems | GET | You can fetch a list of all news items |
List all newsfeedslistNewsfeeds | GET | You can fetch a list of all newsfeeds |
Retrieve a news itemretrieveNewsItem | GET | You can fetch the details of a single news item. |
Retrieve a newsfeedretrieveNewsfeed | GET | You can fetch the details of a single newsfeed |
Update a news itemupdateNewsItem | PUT |
Note5
Create a company notecreateCompanyNote | POST | You can add a note to a single company. |
Create a notecreateNote | POST | You can add a note to a single contact. |
List all company noteslistCompanyNotes | GET | You can fetch a list of notes that are associated to a company. |
List all noteslistNotes | GET | You can fetch a list of notes that are associated to a contact. |
Retrieve a noteretrieveNote | GET | You can fetch the details of a single note. |
Office Hour10
Create an office hours exceptioncreateOfficeHoursException | POST | You can create an exception for an office hours schedule. |
Create an office hours schedulecreateOfficeHoursSchedule | POST | You can create a new office hours schedule for the workspace. |
Delete an office hours exceptiondeleteOfficeHoursException | DELETE | You can delete a single office hours exception. |
Delete an office hours scheduledeleteOfficeHoursSchedule | DELETE | You can delete a single office hours schedule. |
List all office hours exceptionslistOfficeHoursExceptions | GET | You can fetch a list of all exceptions for an office hours schedule. |
List all office hours scheduleslistOfficeHoursSchedules | GET | You can fetch a list of all office hours schedules for the workspace. |
Retrieve an office hours exceptiongetOfficeHoursException | GET | You can fetch the details of a single office hours exception. |
Retrieve an office hours schedulegetOfficeHoursSchedule | GET | You can fetch the details of a single office hours schedule. |
Update an office hours exceptionupdateOfficeHoursException | PUT | You can update an existing office hours exception. |
Update an office hours scheduleupdateOfficeHoursSchedule | PUT | You can update an existing office hours schedule. |
Reporting Data Export4
Download completed export job datadownloadReportingDataExport | GET | Download the data from a completed reporting data export job. |
Enqueue a new reporting data export jobenqueueReportingDataExport | POST | For the conversation dataset, from this version onward this export returns all conversations, including those that never received a user reply. |
Get export job statusgetReportingDataExportJob | GET | |
List available datasets and attributeslistReportingDatasets | GET |
Segment2
List all segmentslistSegments | GET | You can fetch a list of all segments. |
Retrieve a segmentretrieveSegment | GET | You can fetch the details of a single segment. |
Subscription Type3
Add subscription to a contactattachSubscriptionTypeToContact | POST | You can add a specific subscription to a contact. |
List subscription typeslistSubscriptionTypes | GET | You can list all subscription types. |
Remove subscription from a contactdetachSubscriptionTypeToContact | DELETE | You can remove a specific subscription from a contact. |
Switch1
Create a phone SwitchcreatePhoneSwitch | POST | You can use the API to deflect phone calls to the Intercom Messenger. |
Tag10
Add tag to a contactattachTagToContact | POST | You can tag a specific contact. |
Add tag to a conversationattachTagToConversation | POST | You can tag a specific conversation. |
Add tag to a ticketattachTagToTicket | POST | You can tag a specific ticket. |
Create or update a tag, Tag or untag companies, Tag contactscreateTag | POST | You can use this endpoint to perform the following operations: |
Delete tagdeleteTag | DELETE | You can delete the details of tags that are on the workspace by passing in the id. |
Find a specific tagfindTag | GET | You can fetch the details of tags that are on the workspace by their id. |
List all tagslistTags | GET | You can fetch a list of all tags for a given workspace. |
Remove tag from a contactdetachTagFromContact | DELETE | You can remove tag from a specific contact. |
Remove tag from a conversationdetachTagFromConversation | DELETE | You can remove tag from a specific conversation. |
Remove tag from a ticketdetachTagFromTicket | DELETE | You can remove tag from a specific ticket. |
Team3
List all teamslistTeams | GET | This will return a list of team objects for the App. |
Retrieve a teamretrieveTeam | GET | You can fetch the details of a single team, containing an array of admins that belong to this team. |
Retrieve team metricsgetTeamMetrics | GET | Returns real-time activity metrics for admins in the specified team. |
Ticket10
Change ticket typechangeTicketType | POST | You can change the type of a ticket. |
Create a ticketcreateTicket | POST | You can create a new ticket. |
Delete a ticketdeleteTicket | DELETE | {% admonition type="warning" name="Irreversible operation" %} Deleting a ticket is permanent and cannot be reversed. |
Enqueue create ticketenqueueCreateTicket | POST | Enqueues ticket creation for asynchronous processing, returning if the job was enqueued successfully to be processed. |
Link a conversation to a ticketlinkConversationToTicket | POST | Link a conversation to an existing tracker ticket. |
Reply to a ticketreplyTicket | POST | You 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 ticketgetTicket | GET | You can fetch the details of a single ticket. |
Search ticketssearchTickets | POST | You 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 ticketunlinkConversationFromTicket | DELETE | Unlink a conversation (or converted customer ticket) from a tracker ticket it is currently linked to. |
Update a ticketupdateTicket | PUT | You can update a ticket. |
Ticket State1
List all ticket stateslistTicketStates | GET | You can get a list of all ticket states for a workspace. |
Ticket Type4
Create a ticket typecreateTicketType | POST | You can create a new ticket type. |
List all ticket typeslistTicketTypes | GET | You can get a list of all ticket types for a workspace. |
Retrieve a ticket typegetTicketType | GET | You can fetch the details of a single ticket type. |
Update a ticket typeupdateTicketType | PUT | You can update a ticket type. |
Ticket Type Attribute2
Create a new attribute for a ticket typecreateTicketTypeAttribute | POST | You can create a new attribute for a ticket type. |
Update an existing attribute for a ticket typeupdateTicketTypeAttribute | PUT | You can update an existing attribute for a ticket type. |
Visitor3
Convert a visitorconvertVisitor | POST | You can merge a Visitor to a Contact of role type lead or user. |
Retrieve a visitor with User IDretrieveVisitorWithUserId | GET | You can fetch the details of a single visitor. |
Update a visitorupdateVisitor | PUT | Sending a PUT request to /visitors will result in an update of an existing Visitor. |
Workflow1
Export a workflowexportWorkflow | GET | Export a workflow configuration by its ID. |