Read and manage authorized conversations, contacts and workspace resources. Keep support handoffs tied to the original conversation.
Example workflows
Copy a prompt into your connected AI client after connecting this integration. Choose resources you can access and review the supported command before running it.
Identify an admin
Help me with this task in Intercom: Identify an admin. Ask me for any required inputs and confirm the resources and scope before calling the command. Read one response page. Turn the returned data into a concise working summary with original IDs, dates and source links when available. Separate missing information from confirmed results and tell me whether more pages remain. Do not invent fields or change data.
Explore this command: intercom.identifyadmin
Retrieve a macro
Help me with this task in Intercom: Retrieve a macro. Ask me for any required inputs and confirm the resources and scope before calling the command. Read one response page. Turn the returned data into a concise working summary with original IDs, dates and source links when available. Separate missing information from confirmed results and tell me whether more pages remain. Do not invent fields or change data.
Explore this command: intercom.getmacro
What you can do (259)
What you can do
Available commands: 259 (117 read, 142 write). Enable only the commands your application needs.
| Command | Effect |
|---|---|
Identify an admin — intercom.identifyadmin |
Read |
Retrieve a macro — intercom.getmacro |
Read |
List all macros — intercom.listmacros |
Read |
Set an admin to away — intercom.setawayadmin |
Write |
List all activity logs — intercom.listactivitylogs |
Read |
Search activity logs — intercom.searchactivitylogs |
Write |
List all activity log event types — intercom.listactivitylogeventtypes |
Read |
List all admins — intercom.listadmins |
Read |
Retrieve an office hours exception — intercom.getofficehoursexception |
Read |
Update an office hours exception — intercom.updateofficehoursexception |
Write |
Delete an office hours exception — intercom.deleteofficehoursexception |
Write |
List all office hours exceptions — intercom.listofficehoursexceptions |
Read |
Create an office hours exception — intercom.createofficehoursexception |
Write |
Retrieve an office hours schedule — intercom.getofficehoursschedule |
Read |
Update an office hours schedule — intercom.updateofficehoursschedule |
Write |
Delete an office hours schedule — intercom.deleteofficehoursschedule |
Write |
List all office hours schedules — intercom.listofficehoursschedules |
Read |
Create an office hours schedule — intercom.createofficehoursschedule |
Write |
Retrieve an admin — intercom.retrieveadmin |
Read |
Remove an admin — intercom.removeadmin |
Write |
List content import sources — intercom.listcontentimportsources |
Read |
Create a content import source — intercom.createcontentimportsource |
Write |
Delete a content import source — intercom.deletecontentimportsource |
Write |
Retrieve a content import source — intercom.getcontentimportsource |
Read |
Update a content import source — intercom.updatecontentimportsource |
Write |
List external pages — intercom.listexternalpages |
Read |
Create an external page (or update an external page by external ID) — intercom.createexternalpage |
Write |
Delete an external page — intercom.deleteexternalpage |
Write |
Retrieve an external page — intercom.getexternalpage |
Read |
Update an external page — intercom.updateexternalpage |
Write |
Add a tag to an external page — intercom.attachtagtoexternalpage |
Write |
Remove a tag from an external page — intercom.detachtagfromexternalpage |
Write |
List all articles — intercom.listarticles |
Read |
Create an article — intercom.createarticle |
Write |
Retrieve an article — intercom.retrievearticle |
Read |
Update an article — intercom.updatearticle |
Write |
Delete an article — intercom.deletearticle |
Write |
Retrieve an article draft — intercom.retrievearticledraft |
Read |
Stage an article draft — intercom.stagearticledraft |
Write |
Publish an article draft — intercom.publisharticledraft |
Write |
Add a tag to an article — intercom.attachtagtoarticle |
Write |
Remove a tag from an article — intercom.detachtagfromarticle |
Write |
List article versions — intercom.listarticleversions |
Read |
Retrieve an article version — intercom.retrievearticleversion |
Read |
Search for articles — intercom.searcharticles |
Read |
List all away status reasons — intercom.listawaystatusreasons |
Read |
List all audiences — intercom.listaudiences |
Read |
Create an audience — intercom.createaudience |
Write |
Retrieve an audience — intercom.retrieveaudience |
Read |
Update an audience — intercom.updateaudience |
Write |
Delete an audience — intercom.deleteaudience |
Write |
Enqueue a new reporting data export job — intercom.post-.export.reporting_data.enqueue |
Write |
Get export job status — intercom.get-.export.reporting_data.-job_identifier- |
Read |
List available datasets and attributes — intercom.get-.export.reporting_data.get_datasets |
Read |
Start a conversation with Fin — intercom.startfinconversation |
Write |
Reply to Fin — intercom.replytofin |
Write |
Submit a CSAT rating — intercom.submitfincsat |
Write |
Discover Fin's capabilities — intercom.listfincapabilities |
Write |
Ask Fin — intercom.askfin |
Write |
Run a Fin procedure — intercom.runfinprocedure |
Write |
Escalate to a human — intercom.escalatefinconversation |
Write |
List all redirects for a help center — intercom.listhelpcenterredirects |
Read |
Create a redirect — intercom.createhelpcenterredirect |
Write |
Retrieve a redirect — intercom.retrievehelpcenterredirect |
Read |
Delete a redirect — intercom.deletehelpcenterredirect |
Write |
List all collections — intercom.listallcollections |
Read |
Create a collection — intercom.createcollection |
Write |
Retrieve a collection — intercom.retrievecollection |
Read |
Update a collection — intercom.updatecollection |
Write |
Delete a collection — intercom.deletecollection |
Write |
Retrieve a Help Center — intercom.retrievehelpcenter |
Read |
List all Help Centers — intercom.listhelpcenters |
Read |
List all articles — intercom.listinternalarticles |
Read |
Create an internal article — intercom.createinternalarticle |
Write |
Retrieve an internal article — intercom.retrieveinternalarticle |
Read |
Update an internal article — intercom.updateinternalarticle |
Write |
Delete an internal article — intercom.deleteinternalarticle |
Write |
Add a tag to an internal article — intercom.attachtagtointernalarticle |
Write |
Remove a tag from an internal article — intercom.detachtagfrominternalarticle |
Write |
Search for internal articles — intercom.searchinternalarticles |
Read |
List all folders — intercom.listfolders |
Read |
Create a folder — intercom.createfolder |
Write |
Retrieve a folder — intercom.retrievefolder |
Read |
Update a folder — intercom.updatefolder |
Write |
Delete a folder — intercom.deletefolder |
Write |
Get IP allowlist settings — intercom.getipallowlist |
Read |
Update IP allowlist settings — intercom.updateipallowlist |
Write |
Create or Update a company — intercom.createorupdatecompany |
Write |
Retrieve companies — intercom.retrievecompany |
Read |
Retrieve a company by ID — intercom.retrieveacompanybyid |
Read |
Update a company — intercom.updatecompany |
Write |
Delete a company — intercom.deletecompany |
Write |
List attached contacts — intercom.listattachedcontacts |
Read |
List attached segments for companies — intercom.listattachedsegmentsforcompanies |
Read |
List all company notes — intercom.listcompanynotes |
Read |
Create a company note — intercom.createcompanynote |
Write |
Search companies — intercom.searchcompanies |
Write |
List all companies — intercom.listallcompanies |
Write |
Scroll over all companies — intercom.scrolloverallcompanies |
Read |
Attach a Contact to a Company — intercom.attachcontacttoacompany |
Write |
List attached companies for contact — intercom.listcompaniesforacontact |
Read |
Detach a contact from a company — intercom.detachcontactfromacompany |
Write |
List all notes — intercom.listnotes |
Read |
Create a note — intercom.createnote |
Write |
List attached segments for contact — intercom.listsegmentsforacontact |
Read |
List subscriptions for a contact — intercom.listsubscriptionsforacontact |
Read |
Add subscription to a contact — intercom.attachsubscriptiontypetocontact |
Write |
Remove subscription from a contact — intercom.detachsubscriptiontypetocontact |
Write |
List tags attached to a contact — intercom.listtagsforacontact |
Read |
Add tag to a contact — intercom.attachtagtocontact |
Write |
Remove tag from a contact — intercom.detachtagfromcontact |
Write |
List deleted contacts — intercom.listdeletedcontacts |
Read |
Update a contact — intercom.updatecontact |
Write |
Get a contact — intercom.showcontact |
Read |
Delete a contact — intercom.deletecontact |
Write |
Merge a lead and a user — intercom.mergecontact |
Write |
Preview a contact merge — intercom.previewmergecontact |
Write |
Search contacts — intercom.searchcontacts |
Write |
List all contact activities — intercom.listcontactactivities |
Read |
List all contacts — intercom.listcontacts |
Read |
Create contact — intercom.createcontact |
Write |
Get a contact by External ID — intercom.showcontactbyexternalid |
Read |
Archive contact — intercom.archivecontact |
Write |
Unarchive contact — intercom.unarchivecontact |
Write |
List banners for a contact — intercom.listcontactbanners |
Read |
Dismiss a banner for a contact — intercom.dismisscontactbanner |
Write |
Block contact — intercom.blockcontact |
Write |
Get contact merge history — intercom.listcontactmergehistory |
Read |
Bulk create contacts — intercom.bulkcreatecontacts |
Write |
Bulk update contacts — intercom.bulkupdatecontacts |
Write |
Bulk delete contacts — intercom.bulkdeletecontacts |
Write |
Get a bulk update job — intercom.showbulkupdatecontactsjob |
Read |
Run a bulk action on Knowledge Hub content — intercom.bulkcontentactions |
Write |
Search knowledge base contents — intercom.searchcontent |
Read |
List all content snippets — intercom.listcontentsnippets |
Read |
Create a content snippet — intercom.createcontentsnippet |
Write |
Retrieve a content snippet — intercom.getcontentsnippet |
Read |
Update a content snippet — intercom.updatecontentsnippet |
Write |
Delete a content snippet — intercom.deletecontentsnippet |
Write |
Add a tag to a content snippet — intercom.attachtagtocontentsnippet |
Write |
Remove a tag from a content snippet — intercom.detachtagfromcontentsnippet |
Write |
List all dynamic content — intercom.listdynamiccontents |
Read |
Create dynamic content — intercom.createdynamiccontent |
Write |
Retrieve dynamic content — intercom.getdynamiccontent |
Read |
Update dynamic content — intercom.updatedynamiccontent |
Write |
Delete dynamic content — intercom.deletedynamiccontent |
Write |
Add tag to a conversation — intercom.attachtagtoconversation |
Write |
Remove tag from a conversation — intercom.detachtagfromconversation |
Write |
List all conversations — intercom.listconversations |
Read |
Creates a conversation — intercom.createconversation |
Write |
Retrieve a conversation — intercom.retrieveconversation |
Read |
Update a conversation — intercom.updateconversation |
Write |
Delete a conversation — intercom.deleteconversation |
Write |
Search conversations — intercom.searchconversations |
Write |
Reply to a conversation — intercom.replyconversation |
Write |
Manage a conversation — intercom.manageconversation |
Write |
Attach a contact to a conversation — intercom.attachcontacttoconversation |
Write |
Detach a contact from a group conversation — intercom.detachcontactfromconversation |
Write |
List handling events — intercom.listhandlingevents |
Read |
List HITL events — intercom.listhitlevents |
Read |
List side conversations — intercom.listsideconversations |
Read |
Redact a conversation part — intercom.redactconversation |
Write |
Merge a conversation — intercom.mergeconversation |
Write |
Convert a conversation to a ticket — intercom.convertconversationtoticket |
Write |
List all deleted conversation IDs — intercom.listdeletedconversationids |
Read |
List all conversation attributes — intercom.listconversationattributes |
Read |
Create a conversation attribute — intercom.createconversationattribute |
Write |
Get a conversation attribute — intercom.getconversationattribute |
Read |
Update a conversation attribute — intercom.updateconversationattribute |
Write |
Delete (archive) a conversation attribute — intercom.deleteconversationattribute |
Write |
Add an option to a list conversation attribute — intercom.createconversationattributeoption |
Write |
Update an option on a list conversation attribute — intercom.updateconversationattributeoption |
Write |
Archive an option on a list conversation attribute — intercom.deleteconversationattributeoption |
Write |
Create or Update a Custom Object Instance — intercom.createcustomobjectinstances |
Write |
List Custom Object Instances — intercom.listcustomobjectinstances |
Read |
Get Custom Object Instance by ID — intercom.getcustomobjectinstancesbyid |
Read |
Delete a Custom Object Instance by ID — intercom.deletecustomobjectinstancesbyid |
Write |
List all data attributes — intercom.lisdataattributes |
Read |
Create a data attribute — intercom.createdataattribute |
Write |
Update a data attribute — intercom.updatedataattribute |
Write |
List all data connectors — intercom.listdataconnectors |
Read |
Create a data connector — intercom.createdataconnector |
Write |
Retrieve a data connector — intercom.retrievedataconnector |
Read |
Delete a data connector — intercom.deletedataconnector |
Write |
Update a data connector — intercom.updatedataconnector |
Write |
List execution results for a data connector — intercom.listdataconnectorexecutionresults |
Read |
Retrieve an execution result — intercom.showdataconnectorexecutionresult |
Read |
List versions of a data connector — intercom.listdataconnectorversions |
Read |
Retrieve a version of a data connector — intercom.retrievedataconnectorversion |
Read |
Update the note on a data connector version — intercom.updatedataconnectorversion |
Write |
Submit a data event — intercom.createdataevent |
Write |
List all data events — intercom.lisdataevents |
Read |
Create event summaries — intercom.dataeventsummaries |
Write |
Create content data export — intercom.createdataexport |
Write |
Show content data export — intercom.getdataexport |
Read |
Cancel content data export — intercom.canceldataexport |
Write |
Download content data export — intercom.downloaddataexport |
Read |
Retrieve job status — intercom.jobsstatus |
Read |
Create a message — intercom.createmessage |
Write |
Retrieve WhatsApp message delivery status — intercom.retrievewhatsappmessagestatus |
Read |
Get statuses of all messages sent based on the specified ruleset_id — intercom.getwhatsappmessagestatus |
Read |
List all news items — intercom.listnewsitems |
Read |
Create a news item — intercom.createnewsitem |
Write |
Retrieve a news item — intercom.retrievenewsitem |
Read |
Update a news item — intercom.updatenewsitem |
Write |
Delete a news item — intercom.deletenewsitem |
Write |
List all live newsfeed items — intercom.listlivenewsfeeditems |
Read |
List all newsfeeds — intercom.listnewsfeeds |
Read |
Retrieve a newsfeed — intercom.retrievenewsfeed |
Read |
Retrieve a note — intercom.retrievenote |
Read |
Delete a note — intercom.deletenote |
Write |
List all segments — intercom.listsegments |
Read |
Retrieve a segment — intercom.retrievesegment |
Read |
List subscription types — intercom.listsubscriptiontypes |
Read |
Retrieve a subscription type — intercom.getsubscriptiontype |
Read |
Create a phone Switch — intercom.createphoneswitch |
Write |
List all calls — intercom.listcalls |
Read |
Get a call — intercom.showcall |
Read |
Get call transcript by call id — intercom.showcalltranscript |
Read |
List calls with transcripts — intercom.listcallswithtranscripts |
Write |
List all tags — intercom.listtags |
Read |
Create or update a tag, Tag or untag companies, Tag contacts — intercom.createtag |
Write |
Find a specific tag — intercom.findtag |
Read |
Delete tag — intercom.deletetag |
Write |
List all teams — intercom.listteams |
Read |
Retrieve a team — intercom.retrieveteam |
Read |
Retrieve team metrics — intercom.getteammetrics |
Read |
List all ticket states — intercom.listticketstates |
Read |
Create a new attribute for a ticket type — intercom.createtickettypeattribute |
Write |
Update an existing attribute for a ticket type — intercom.updatetickettypeattribute |
Write |
List all ticket types — intercom.listtickettypes |
Read |
Create a ticket type — intercom.createtickettype |
Write |
Retrieve a ticket type — intercom.gettickettype |
Read |
Update a ticket type — intercom.updatetickettype |
Write |
Reply to a ticket — intercom.replyticket |
Write |
Add tag to a ticket — intercom.attachtagtoticket |
Write |
Remove tag from a ticket — intercom.detachtagfromticket |
Write |
Link a conversation to a ticket — intercom.linkconversationtoticket |
Write |
Unlink a conversation from a ticket — intercom.unlinkconversationfromticket |
Write |
Create a ticket — intercom.createticket |
Write |
Enqueue create ticket — intercom.enqueuecreateticket |
Write |
Update a ticket — intercom.updateticket |
Write |
Retrieve a ticket — intercom.getticket |
Read |
Delete a ticket — intercom.deleteticket |
Write |
Change ticket type — intercom.changetickettype |
Write |
Search tickets — intercom.searchtickets |
Write |
Update a visitor — intercom.updatevisitor |
Write |
Retrieve a visitor with User ID — intercom.retrievevisitorwithuserid |
Read |
Convert a visitor — intercom.convertvisitor |
Write |
List all brands — intercom.listbrands |
Read |
Retrieve a brand — intercom.retrievebrand |
Read |
List all email settings — intercom.listemails |
Read |
Retrieve an email setting — intercom.retrieveemail |
Read |
Register a Fin Voice call — intercom.registerfinvoicecall |
Write |
Collect Fin Voice call by ID — intercom.collectfinvoicecallbyid |
Read |
Collect Fin Voice call by external ID — intercom.collectfinvoicecallbyexternalid |
Read |
Collect Fin Voice call by phone number — intercom.collectfinvoicecallbyphonenumber |
Read |
Collect Fin Voice calls by conversation ID — intercom.collectfinvoicecallsbyconversationid |
Read |
Export a workflow — intercom.exportworkflow |
Read |
Connect and use
This connection uses your provider account.
Connect this integration, enter your provider credentials, choose commands and save. Complete provider authorization if prompted.
Get your provider credentials
Follow these steps for Intercom, then enter the issued values in the connection form below.
- In the Intercom Developer Hub, open or create an app for the intended workspace, configure the required permissions and obtain its access token following the official authentication guide. Paste it into this connection’s Intercom workspace app access token field. Start with identifyadmin; selected commands must match the token’s permissions. This pinned contract uses Intercom-Version 2.17 and the default api.intercom.io region; EU/AU regional origins require separate reviewed configuration. Conversations, contacts and outbound content can affect customers. Save only needed commands and create a separate scoped Tooluse.net API key. Never expose the Intercom token in the MCP URL.
Where to enter credentials
In the integration page, sign in, choose your workspace and open Connect. If a Credentials choice is shown, select Use my credentials. Fill the following connection fields and save. Provider credentials belong in this form, never in an MCP configuration or tool input.
| Connection field | Requirement |
|---|---|
| Intercom workspace app access token | Required |
Open API keys and create a Tooluse.net key for the enabled commands.
Set TOOLUSE_API_KEY in your client and use the shared MCP configuration.
Configure Claude Code, Codex or Cursor once
Permissions and results
If you have more than one workspace, check the selected workspace in the connection or API-key dialog before saving. Roles, enabled commands, expiry and revocation use Tooluse.net's existing permissions. Disabling a connection or revoking a key immediately prevents new calls.
Send one Claude tool_use block per request. Keep the same Idempotency-Key when retrying the same request; use a new key for a new call. The response includes the shared Tooluse.net receipt and Claude tool_result. Check both HTTP status and the returned tool result before treating a call as successful.
Your connection's daily allowance and key permissions also apply. Adding a connection does not make a provider request.
Calls return the shared execution receipt and a Claude tool_result. Provider output varies by operation; consult the provider documentation for its response fields. Unconfirmed calls should be checked before retrying.
Call from your client
Use the shared MCP configuration. Refresh your client's tool list after saving the connection or changing key permissions, then call the returned tool name with the example input below.
Configure Claude Code, Codex or Cursor once
Discover your enabled tools
List permitted tools in Claude format. Read every page using page and size (maximum 100) until all results have been received. Use the returned name, not a catalog capability identifier, in the tool_use block.
curl 'https://api.tooluse.net/v1/tools' \
-H "Authorization: Bearer $TOOLUSE_API_KEY"
Find this command in the tool list permitted by your key. Replace svc_FROM_YOUR_TOOL_LIST with its returned name. Use a new Idempotency-Key for each new call and retain it when retrying that same call.
HTTP call
curl 'https://api.tooluse.net/v1/tool-calls' \
-H "Authorization: Bearer $TOOLUSE_API_KEY" \
-H 'Content-Type: application/json' \
-H 'Idempotency-Key: replace-with-a-new-call-id' \
--data '{
"type": "tool_use",
"id": "toolu_example",
"name": "svc_FROM_YOUR_TOOL_LIST",
"input": {}
}'
Send one Claude tool_use block per request. Keep the same Idempotency-Key when retrying the same request; use a new key for a new call. The response includes the shared Tooluse.net receipt and Claude tool_result. Check both HTTP status and the returned tool result before treating a call as successful.
Commands
Identify an admin — intercom.identifyadmin
You can view the currently authorised admin along with the embedded app object (a "workspace" in legacy terminology).
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a macro — intercom.getmacro
You can fetch a single macro (saved reply) by its ID. The macro will only be returned if it is visible to the authenticated user based on its visibility settings.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The unique identifier of the macro |
Full JSON Schema
Example input
{
"path": {
"id": "123"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List all macros — intercom.listmacros
You can fetch a list of all macros (saved replies) in your workspace for use in automating responses.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
query |
object | Optional | additionalProperties: false |
|
query.per_page |
integer | Optional | The number of results per page | default: 50; minimum: 1; maximum: 150 |
query.starting_after |
string | Optional | Base64-encoded cursor containing [updated_at, id] for pagination | |
query.updated_since |
integer | Optional | Unix timestamp to filter macros updated after this time |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Set an admin to away — intercom.setawayadmin
You can set an Admin as away for the Inbox.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.admin_id |
integer | Required | The unique identifier of a given admin | |
body |
object | Optional | ||
body.away_mode_enabled |
boolean | Required | Set to true to change the status of the admin to away, or false to set them back to active. |
|
body.away_mode_reassign |
boolean | Required | Set to "true" to assign any new conversation replies to your default inbox. | |
body.away_status_reason_id |
integer | Optional | The unique identifier of the away status reason. Only allowed when away_mode_enabled is true, and the reason can't be archived, unless it is already the admin's current reason. Required if your workspace makes away status reasons mandatory. |
Full JSON Schema
Example input
{
"path": {
"admin_id": 1
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List all activity logs — intercom.listactivitylogs
You can get a log of activities by all admins in an app.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
query |
object | Optional | additionalProperties: false |
|
query.created_at_after |
string | Optional | The start date that you request data for. It must be formatted as a UNIX timestamp. If you leave it out, it defaults to 30 days before the request. | |
query.created_at_before |
string | Optional | The end date that you request data for. It must be formatted as a UNIX timestamp. If you leave it out, it defaults to the time of the request. | |
query.page |
integer | Optional | The page number of results to return. Defaults to the first page. | default: 1 |
query.per_page |
integer | Optional | The number of results per page. Must be between 1 and 250. | default: 20; minimum: 1; maximum: 250 |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Search activity logs — intercom.searchactivitylogs
Search and filter admin activity logs using a POST request with event type filter in the request body. You can find more details about the available event types in the List all activity log event types endpoint.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
body |
object | Required | ||
body.created_at_after |
integer | Optional | The start date that you request data for. It must be formatted as a UNIX timestamp. If you leave it out, it defaults to 30 days before the request. | format: "date-time" |
body.created_at_before |
integer | Optional | The end date that you request data for. It must be formatted as a UNIX timestamp. If you leave it out, it defaults to the time of the request. | format: "date-time" |
body.event_types |
array | Optional | An optional list of event types to filter activity logs by. Use the list all activity log event types endpoint to retrieve available values. | |
body.event_types[] |
string | Optional | ||
body.page |
integer | Optional | The page number of results to return. | default: 1 |
body.per_page |
integer | Optional | The number of results per page. Must be between 1 and 250. | default: 20; minimum: 1; maximum: 250 |
Full JSON Schema
Example input
{
"body": {
"created_at_after": 1677253093,
"created_at_before": 1677861493,
"event_types": [
"app_name_change",
"message_state_change"
]
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List all activity log event types — intercom.listactivitylogeventtypes
You can get a list of all activity log event types. This is useful for discovering valid values to use with the event_types filter on the Search activity logs endpoint.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
List all admins — intercom.listadmins
You can fetch a list of admins for a given workspace.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
query |
object | Optional | additionalProperties: false |
|
query.display_avatar |
boolean | Optional | If set to true, the response will include the admin's avatar object containing the image URL. Defaults to false. |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve an office hours exception — intercom.getofficehoursexception
You can fetch the details of a single office hours exception.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.office_hours_schedule_id |
string | Required | The unique identifier for the office hours schedule. | |
path.id |
string | Required | The unique identifier for the office hours exception. |
Full JSON Schema
Example input
{
"path": {
"office_hours_schedule_id": "123",
"id": "456"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update an office hours exception — intercom.updateofficehoursexception
You can update an existing office hours exception.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.office_hours_schedule_id |
string | Required | The unique identifier for the office hours schedule. | |
path.id |
string | Required | The unique identifier for the office hours exception. | |
body |
— | Optional | $ref: "#/definitions/update_office_hours_exception_request" |
Full JSON Schema
Example input
{
"path": {
"office_hours_schedule_id": "123",
"id": "456"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete an office hours exception — intercom.deleteofficehoursexception
You can delete a single office hours exception.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.office_hours_schedule_id |
string | Required | The unique identifier for the office hours schedule. | |
path.id |
string | Required | The unique identifier for the office hours exception. |
Full JSON Schema
Example input
{
"path": {
"office_hours_schedule_id": "123",
"id": "456"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List all office hours exceptions — intercom.listofficehoursexceptions
You can fetch a list of all exceptions for an office hours schedule, ordered by date with the earliest first.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.office_hours_schedule_id |
string | Required | The unique identifier for the office hours schedule. |
Full JSON Schema
Example input
{
"path": {
"office_hours_schedule_id": "123"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create an office hours exception — intercom.createofficehoursexception
You can create an exception for an office hours schedule. Use closed to mark the day closed (omit time_intervals) or custom_hours to supply replacement intervals.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.office_hours_schedule_id |
string | Required | The unique identifier for the office hours schedule. | |
body |
— | Required | $ref: "#/definitions/create_office_hours_exception_request" |
Full JSON Schema
Example input
{
"path": {
"office_hours_schedule_id": "123"
},
"body": {
"exception_date": "2026-12-25",
"exception_type": "closed"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve an office hours schedule — intercom.getofficehoursschedule
You can fetch the details of a single office hours schedule.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The unique identifier for the office hours schedule. |
Full JSON Schema
Example input
{
"path": {
"id": "123"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update an office hours schedule — intercom.updateofficehoursschedule
You can update an existing office hours schedule.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The unique identifier for the office hours schedule. | |
body |
— | Optional | $ref: "#/definitions/update_office_hours_schedule_request" |
Full JSON Schema
Example input
{
"path": {
"id": "123"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete an office hours schedule — intercom.deleteofficehoursschedule
You can delete a single office hours schedule. The workspace's default schedule can't be deleted.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The unique identifier for the office hours schedule. |
Full JSON Schema
Example input
{
"path": {
"id": "123"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List all office hours schedules — intercom.listofficehoursschedules
You can fetch a list of all office hours schedules for the workspace.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create an office hours schedule — intercom.createofficehoursschedule
You can create a new office hours schedule for the workspace.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
body |
— | Required | $ref: "#/definitions/create_office_hours_schedule_request" |
Full JSON Schema
Example input
{
"body": {
"name": "Standard Support Hours",
"time_intervals": []
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve an admin — intercom.retrieveadmin
You can retrieve the details of a single admin.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.admin_id |
integer | Required | The unique identifier of a given admin |
Full JSON Schema
Example input
{
"path": {
"admin_id": 123
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Remove an admin — intercom.removeadmin
You can remove a single admin (teammate) from your workspace. Requires the remove_admins OAuth scope.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
query |
object | Required | additionalProperties: false |
|
query.admin_id |
integer | Required | The unique identifier of the admin to remove. | |
query.reassign_messages_admin_id |
integer | Required | The unique identifier of a human admin to reassign the removed admin's auto-message ownership to. | |
query.reassign_owner_admin_id |
integer | Required | The unique identifier of a human admin to reassign the removed admin's ownership (of users and leads) to. | |
query.reassign_articles_author_id |
integer | Required | The unique identifier of a human admin to reassign the removed admin's article authorship to. | |
query.reassign_conversations_admin_id |
integer | Required | The ID of an admin with Inbox access, or a team, to reassign the removed admin's conversation replies to. Pass 0 to leave conversations unassigned. |
|
query.reassign_replies_teams |
array | Optional | A list of teams and the admin each team's conversation replies should be reassigned to. | |
query.reassign_replies_teams[] |
object | Optional | ||
query.reassign_replies_teams[].team_id |
integer | Optional | ||
query.reassign_replies_teams[].assignee_id |
integer | Optional |
Full JSON Schema
Example input
{
"query": {
"admin_id": 123,
"reassign_messages_admin_id": 456,
"reassign_owner_admin_id": 456,
"reassign_articles_author_id": 456,
"reassign_conversations_admin_id": 456
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List content import sources — intercom.listcontentimportsources
You can retrieve a list of all content import sources for a workspace.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
query |
object | Optional | additionalProperties: false |
|
query.page |
integer | Optional | The page of results to fetch. Defaults to the first page. | default: 1; minimum: 1 |
query.per_page |
integer | Optional | The number of results to return per page. Maximum 150. | default: 50; minimum: 1; maximum: 150 |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a content import source — intercom.createcontentimportsource
You can create a new content import source by sending a POST request to this endpoint.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
body |
— | Optional | $ref: "#/definitions/create_content_import_source_request" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete a content import source — intercom.deletecontentimportsource
You can delete a content import source by making a DELETE request this endpoint. This will also delete all external pages that were imported from this source.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.source_id |
string | Required | The unique identifier for the content import source which is given by Intercom. | |
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
Full JSON Schema
Example input
{
"path": {
"source_id": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a content import source — intercom.getcontentimportsource
You can retrieve a content import source.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.source_id |
string | Required | The unique identifier for the content import source which is given by Intercom. | |
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
Full JSON Schema
Example input
{
"path": {
"source_id": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update a content import source — intercom.updatecontentimportsource
You can update an existing content import source.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.source_id |
string | Required | The unique identifier for the content import source which is given by Intercom. | |
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
body |
— | Optional | $ref: "#/definitions/update_content_import_source_request" |
Full JSON Schema
Example input
{
"path": {
"source_id": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List external pages — intercom.listexternalpages
You can retrieve a list of all external pages for a workspace.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
query |
object | Optional | additionalProperties: false |
|
query.page |
integer | Optional | The page of results to fetch. Defaults to the first page. page cannot exceed 5,001, and page multiplied by per_page cannot exceed 10,000. Past 5,001 the API returns a 400 parameter_invalid error; past 10,000 results it returns a 400 bad_request error with the message page limit reached, please use scroll API. |
default: 1; minimum: 1 |
query.per_page |
integer | Optional | The number of results to return per page. Maximum 150. | default: 50; minimum: 1; maximum: 150 |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create an external page (or update an external page by external ID) — intercom.createexternalpage
You can create a new external page by sending a POST request to this endpoint. If an external page already exists with the specified source_id and external_id, it will be updated instead.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
body |
— | Optional | $ref: "#/definitions/create_external_page_request" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete an external page — intercom.deleteexternalpage
Sending a DELETE request for an external page will remove it from the content library UI and from being used for AI answers.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.page_id |
string | Required | The unique identifier for the external page which is given by Intercom. | |
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
Full JSON Schema
Example input
{
"path": {
"page_id": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve an external page — intercom.getexternalpage
You can retrieve an external page.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.page_id |
string | Required | The unique identifier for the external page which is given by Intercom. | |
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
Full JSON Schema
Example input
{
"path": {
"page_id": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update an external page — intercom.updateexternalpage
You can update an existing external page (if it was created via the API).
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.page_id |
string | Required | The unique identifier for the external page which is given by Intercom. | |
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
body |
— | Optional | $ref: "#/definitions/update_external_page_request" |
Full JSON Schema
Example input
{
"path": {
"page_id": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Add a tag to an external page — intercom.attachtagtoexternalpage
Apply an existing tag to an external page. Returns the tag that was applied.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.external_page_id |
string | Required | The unique identifier for the external page which is given by Intercom. | |
body |
object | Optional | ||
body.id |
string | Required | The unique identifier of the tag to apply, as given by Intercom. | |
body.admin_id |
string | null | Optional | Optional id of the teammate to attribute the tagging to. Defaults to the authenticating teammate. |
Full JSON Schema
Example input
{
"path": {
"external_page_id": "1234"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Remove a tag from an external page — intercom.detachtagfromexternalpage
Remove a tag from an external page. Returns the tag that was removed, with null applied_at and applied_by.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.external_page_id |
string | Required | The unique identifier for the external page which is given by Intercom. | |
path.id |
string | Required | The unique identifier of the tag to remove, as given by Intercom. |
Full JSON Schema
Example input
{
"path": {
"external_page_id": "1234",
"id": "7522907"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List all articles — intercom.listarticles
You can fetch a list of all articles by making a GET request to https://api.intercom.io/articles.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
query |
object | Optional | additionalProperties: false |
|
query.page |
integer | Optional | The page of results to fetch. Defaults to the first page. | |
query.per_page |
integer | Optional | The number of results to return per page. Defaults to 25. Maximum is 250. | maximum: 250 |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create an article — intercom.createarticle
You can create a new article by making a POST request to https://api.intercom.io/articles.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
body |
— | Optional | $ref: "#/definitions/create_article_request" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve an article — intercom.retrievearticle
You can fetch the details of a single article by making a GET request to https://api.intercom.io/articles/<id>.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.article_id |
integer | Required | The unique identifier for the article which is given by Intercom. |
Full JSON Schema
Example input
{
"path": {
"article_id": 123
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update an article — intercom.updatearticle
You can update the details of a single article by making a PUT request to https://api.intercom.io/articles/<id>.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.article_id |
integer | Required | The unique identifier for the article which is given by Intercom. | |
body |
— | Optional | $ref: "#/definitions/update_article_request" |
Full JSON Schema
Example input
{
"path": {
"article_id": 123
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete an article — intercom.deletearticle
You can delete a single article by making a DELETE request to https://api.intercom.io/articles/<id>.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.article_id |
integer | Required | The unique identifier for the article which is given by Intercom. |
Full JSON Schema
Example input
{
"path": {
"article_id": 123
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve an article draft — intercom.retrievearticledraft
Fetch the staged draft of a published article by making a GET request to https://api.intercom.io/articles/<id>/draft. The response is the article rendered with its draft content, leaving the live article untouched.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.id |
integer | Required | The unique identifier for the article which is given by Intercom. |
Full JSON Schema
Example input
{
"path": {
"id": 123
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Stage an article draft — intercom.stagearticledraft
Stage changes to a published article as a draft by making a PUT request to https://api.intercom.io/articles/<id>/draft. The live article remains unchanged until the draft is published.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.id |
integer | Required | The unique identifier for the article which is given by Intercom. | |
body |
— | Optional | $ref: "#/definitions/update_article_request" |
Full JSON Schema
Example input
{
"path": {
"id": 123
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Publish an article draft — intercom.publisharticledraft
Publish a staged draft by making a POST request to https://api.intercom.io/articles/<id>/draft/publish, promoting the draft content to live.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.id |
integer | Required | The unique identifier for the article which is given by Intercom. | |
body |
— | Optional | $ref: "#/definitions/publish_article_draft_request" |
Full JSON Schema
Example input
{
"path": {
"id": 123
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Add a tag to an article — intercom.attachtagtoarticle
Apply an existing tag to an article. Returns the tag that was applied.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.article_id |
integer | Required | The unique identifier for the article which is given by Intercom. | |
body |
object | Optional | ||
body.id |
string | Required | The unique identifier of the tag to apply, as given by Intercom. | |
body.admin_id |
string | null | Optional | Optional id of the teammate to attribute the tagging to. Defaults to the authenticating teammate. Does not affect authorization. |
Full JSON Schema
Example input
{
"path": {
"article_id": 123
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Remove a tag from an article — intercom.detachtagfromarticle
Remove a tag from an article. Returns the tag that was removed, with null applied_at and applied_by.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.article_id |
integer | Required | The unique identifier for the article which is given by Intercom. | |
path.id |
string | Required | The unique identifier of the tag to remove, as given by Intercom. |
Full JSON Schema
Example input
{
"path": {
"article_id": 123,
"id": "7522907"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List article versions — intercom.listarticleversions
Fetch the version history of an article by making a GET request to https://api.intercom.io/articles/<article_id>/versions. Versions are returned newest-first as a paginated list of metadata. Use GET /articles/{article_id}/versions/{id} to retrieve a single version with its full content.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.article_id |
integer | Required | The unique identifier for the article whose versions you are listing. | |
query |
object | Optional | additionalProperties: false |
|
query.page |
integer | Optional | The page of results to fetch. Defaults to the first page. | |
query.per_page |
integer | Optional | The number of results to return per page. Defaults to 10. | |
query.locale |
string | Optional | Filter versions to a specific locale. Use the locale identifier (for example en, fr). If the article has no content in that locale, a 400 is returned. |
Full JSON Schema
Example input
{
"path": {
"article_id": 123
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve an article version — intercom.retrievearticleversion
Fetch a single prior version of an article, including its body content, by making a GET request to https://api.intercom.io/articles/<article_id>/versions/<id>. Returns the version's full content; the live article remains untouched.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.article_id |
integer | Required | The unique identifier for the article. | |
path.id |
string | Required | The unique identifier for the version. | |
query |
object | Optional | additionalProperties: false |
|
query.locale |
string | Optional | Return the version's content for a specific locale. If the article has no content in that locale, a 400 is returned. |
Full JSON Schema
Example input
{
"path": {
"article_id": 123,
"id": "301"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Search for articles — intercom.searcharticles
You can search for articles by making a GET request to https://api.intercom.io/articles/search.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
query |
object | Optional | additionalProperties: false |
|
query.phrase |
string | Optional | The phrase within your articles to search for. Maximum length is 500 characters. | maxLength: 500 |
query.state |
string | Optional | The state of the Articles returned. One of published, draft or all. Defaults to published. |
enum: ["published","draft","all"]; default: "published" |
query.help_center_id |
integer | Optional | The ID of the Help Center to search in. | |
query.highlight |
boolean | Optional | Return a highlighted version of the matching content within your articles. Refer to the response schema for more details. | |
query.page |
integer | Optional | The page of results to fetch. Defaults to the first page. | |
query.per_page |
integer | Optional | The number of results to return per page. Defaults to 10. |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
List all away status reasons — intercom.listawaystatusreasons
Returns a list of all away status reasons configured for the workspace, including deleted ones.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
List all audiences — intercom.listaudiences
You can fetch a list of all audiences for the workspace.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
query |
object | Optional | additionalProperties: false |
|
query.page |
integer | Optional | The page of results to fetch. Defaults to the first page. Values below 1 are treated as 1. | |
query.per_page |
integer | Optional | The number of results to return per page. Defaults to 50. Values above 50 are reduced to 50, and values below 1 are treated as 1. | maximum: 50 |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create an audience — intercom.createaudience
You can create a new audience by making a POST request to https://api.intercom.io/audiences.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
body |
— | Required | $ref: "#/definitions/create_audience_request" |
Full JSON Schema
Example input
{
"body": {
"name": "VIP Customers"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve an audience — intercom.retrieveaudience
You can fetch the details of a single audience by making a GET request to https://api.intercom.io/audiences/{id}.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The unique identifier for the audience. |
Full JSON Schema
Example input
{
"path": {
"id": "123"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update an audience — intercom.updateaudience
You can update the details of a single audience by making a PUT request to https://api.intercom.io/audiences/{id}.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The unique identifier for the audience. | |
body |
— | Optional | $ref: "#/definitions/update_audience_request" |
Full JSON Schema
Example input
{
"path": {
"id": "123"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete an audience — intercom.deleteaudience
You can delete a single audience by making a DELETE request to https://api.intercom.io/audiences/{id}.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The unique identifier for the audience. |
Full JSON Schema
Example input
{
"path": {
"id": "123"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Enqueue a new reporting data export job — intercom.post-.export.reporting_data.enqueue
For the conversation dataset, from API version 2.16 this export returns all conversations, including those that never received a user reply. Earlier versions return only conversations that received at least one user reply. Other datasets are unaffected.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
body |
object | Required | ||
body.dataset_id |
string | Required | ||
body.attribute_ids |
array | Required | List of attribute identifiers to include in the export. Requires qualified_id format (e.g., "people.Brand", "standard.conversation_id"). Use the qualified_id returned from the get_datasets response. | |
body.attribute_ids[] |
string | Optional | ||
body.start_time |
integer | Required | Start of the export period, as a Unix timestamp in seconds. Must be within your workspace's reporting data retention period, which is 2 years by default (3 years for workspaces with extended retention). | |
body.end_time |
integer | Required | End of the export period, as a Unix timestamp in seconds. Must not be earlier than start_time and must also be within the retention period. |
Full JSON Schema
Example input
{
"body": {
"dataset_id": "conversation",
"attribute_ids": [
"standard.conversation_id",
"timestamp.conversation_started_at"
],
"start_time": 1788220800,
"end_time": 1788307200
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get export job status — intercom.get-.export.reporting_data.-job_identifier-
Requires the export_reporting_data OAuth scope.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.job_identifier |
string | Required | Unique identifier of the job. |
Full JSON Schema
Example input
{
"path": {
"job_identifier": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List available datasets and attributes — intercom.get-.export.reporting_data.get_datasets
Requires the export_reporting_data or read_reporting_datasets OAuth scope.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Start a conversation with Fin — intercom.startfinconversation
Initialize Fin by passing it the user's message along with conversation history and user details.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
body |
object | Required | ||
body.conversation_id |
string | Required | The ID of the conversation that is calling Fin via this API. | |
body.message |
— | Required | $ref: "#/definitions/fin_agent_message" |
|
body.user |
— | Required | $ref: "#/definitions/fin_agent_user" |
|
body.attachments |
array | Optional | An array of attachments to include with the message. Maximum of 10 attachments. | maxItems: 10 |
body.attachments[] |
— | Optional | $ref: "#/definitions/fin_agent_attachment" |
|
body.conversation_metadata |
— | Optional | $ref: "#/definitions/fin_agent_conversation_metadata" |
|
body.environment |
string | Optional | The identifier of the environment to start the conversation in. Only Fin for Platforms workspaces use it; other workspaces ignore it. Use the same value as messenger_environment in your Messenger installation. Defaults to the workspace's default environment. On a Fin for Platforms workspace, an identifier that matches no environment returns a 422 error. |
|
body.response_format |
string | Optional | The format of the body in Fin's replies. Defaults to html. Requesting markdown on a workspace where it is not enabled returns a 403 error. |
enum: ["html","markdown"]; default: "html" |
Full JSON Schema
Example input
{
"body": {
"conversation_id": "ext-123",
"message": {
"author": "user",
"body": "How can I see my account details?",
"timestamp": "2025-01-24T10:01:20.000Z"
},
"user": {
"id": "123456",
"name": "John Doe",
"email": "[email protected]"
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Reply to Fin — intercom.replytofin
Once Fin has returned a response to a user's message, its status will be awaiting_user_reply.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
body |
object | Required | ||
body.conversation_id |
string | Required | The ID of the conversation. | |
body.message |
— | Required | $ref: "#/definitions/fin_agent_message" |
|
body.user |
— | Required | $ref: "#/definitions/fin_agent_user" |
|
body.attachments |
array | Optional | An array of attachments to include with the message. Maximum of 10 attachments. | maxItems: 10 |
body.attachments[] |
— | Optional | $ref: "#/definitions/fin_agent_attachment" |
|
body.response_format |
string | Optional | The format of the body in Fin's replies. Defaults to html. Requesting markdown on a workspace where it is not enabled returns a 403 error. |
enum: ["html","markdown"]; default: "html" |
Full JSON Schema
Example input
{
"body": {
"conversation_id": "123456",
"message": {
"author": "user",
"body": "Here's the information you requested.",
"timestamp": "2025-01-24T09:01:00.000Z"
},
"user": {
"id": "123456",
"name": "John Doe",
"email": "[email protected]"
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Submit a CSAT rating — intercom.submitfincsat
Record a customer's satisfaction rating for a conversation, with an optional free-text remark.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
body |
object | Required | ||
body.conversation_id |
string | Required | Your external conversation ID — the same ID you started the conversation with, and the one echoed on the csat_requested event. |
|
body.rating |
string | Required | The rating the user selected — one of the key values from the csat_requested event's options. |
enum: ["terrible","bad","ok","good","amazing"] |
body.remark |
string | Optional | Optional free-text comment the user left alongside the rating. Can be added to an already-rated survey, but only once — the rating locks after a remark is recorded. |
Full JSON Schema
Example input
{
"body": {
"conversation_id": "ext-123",
"rating": "amazing"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Discover Fin's capabilities — intercom.listfincapabilities
Return a machine-readable, per-user list of what Fin can do for a given end user, so an orchestrating agent can decide which endpoint to call.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
body |
object | Required | ||
body.user |
— | Required | ||
body.user |
— | Required | allOf[1]; $ref: "#/definitions/fin_agent_user" |
|
body.user |
— | Required | The user to list capabilities for. If no user exists for the id, one is created from the supplied details; if the user already exists, the supplied email and attributes update it. | allOf[2] |
Full JSON Schema
Example input
{
"body": {
"user": {
"id": "123456"
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Ask Fin — intercom.askfin
Ask Fin a single, self-contained question and receive one informational answer.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
body |
object | Required | ||
body.conversation_id |
string | Required | Your external conversation ID. Fin creates a conversation for this ID. If a conversation already exists for it, use /fin/reply instead. |
|
body.message |
— | Required | $ref: "#/definitions/fin_agent_message" |
|
body.user |
— | Required | $ref: "#/definitions/fin_agent_user" |
|
body.conversation_metadata |
— | Optional | $ref: "#/definitions/fin_agent_conversation_metadata" |
|
body.attachments |
array | Optional | An array of attachments to include with the message. Maximum of 10 attachments. | maxItems: 10 |
body.attachments[] |
— | Optional | $ref: "#/definitions/fin_agent_attachment" |
|
body.environment |
string | Optional | The identifier of the environment to start the conversation in. Only Fin for Platforms workspaces use it; other workspaces ignore it. Use the same value as messenger_environment in your Messenger installation. Defaults to the workspace's default environment. On a Fin for Platforms workspace, an identifier that matches no environment returns a 422 error. |
|
body.response_format |
string | Optional | The format of the body in Fin's replies. Defaults to html. Requesting markdown on a workspace where it is not enabled returns a 403 error. |
enum: ["html","markdown"]; default: "html" |
Full JSON Schema
Example input
{
"body": {
"conversation_id": "ext-123",
"message": {
"author": "user",
"body": "How do I reset my password?",
"timestamp": "2025-01-24T10:01:20.000Z"
},
"user": {
"id": "123456",
"name": "John Doe",
"email": "[email protected]"
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Run a Fin procedure — intercom.runfinprocedure
Deterministically run a specific procedure on a new conversation. Calling this endpoint guarantees that the named procedure runs — there is no non-deterministic routing.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.procedure_id |
string | Required | The ID of the procedure to run. | |
body |
object | Required | ||
body.conversation_id |
string | Required | Your external conversation ID. Fin creates a conversation for this ID. If a conversation already exists for it, use /fin/reply instead. |
|
body.user |
— | Required | $ref: "#/definitions/fin_agent_user" |
|
body.message |
object | Optional | Optional message posted to the conversation before the procedure runs. Only body is required. |
|
body.message.body |
string | Required | The body of the message. | |
body.message.author |
string | Optional | Accepted but has no effect. The trigger message is always posted as an operator message. | enum: ["user","agent","fin"] |
body.conversation_metadata |
object | Optional | Metadata about the conversation. Only attributes are accepted (no history). | |
body.conversation_metadata.attributes |
object | Optional | A hash of conversation attributes. Limit to 20 attributes. | maxProperties: 20; additionalProperties: true |
body.environment |
string | Optional | The identifier of the environment to start the conversation in. Only Fin for Platforms workspaces use it; other workspaces ignore it. Use the same value as messenger_environment in your Messenger installation. Defaults to the workspace's default environment. On a Fin for Platforms workspace, an identifier that matches no environment returns a 422 error. |
Full JSON Schema
Example input
{
"path": {
"procedure_id": "12345"
},
"body": {
"conversation_id": "ext-123",
"user": {
"id": "123456",
"name": "John Doe",
"email": "[email protected]"
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Escalate to a human — intercom.escalatefinconversation
Hand a conversation off to a human teammate. If you use the Intercom Helpdesk, the handoff lands in your team inbox.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
body |
object | Required | ||
body.conversation_id |
string | Optional | The external ID of the conversation to escalate. Provide this or user. Required on Fin for Platforms, where user is not supported. |
|
body.user |
— | Optional | ||
body.user |
— | Optional | allOf[1]; $ref: "#/definitions/fin_agent_user" |
|
body.user |
— | Optional | The user to escalate on behalf of, creating a new conversation. Provide this or conversation_id. Not supported on Fin for Platforms. |
allOf[2] |
body.context |
string | Optional | Optional background for the receiving teammate, valid with either conversation_id or user. On the Intercom Helpdesk, it appears above the summary in the internal note of the new conversation the teammate picks up, and is never shown to the end user. Not surfaced on Fin for Platforms. Avoid including credentials or unnecessary personal data — it is visible to any teammate with access to the conversation. |
maxLength: 10000 |
body |
— | Required | oneOf[1] |
|
body |
— | Required | oneOf[2] |
Full JSON Schema
Example input
{
"body": {
"conversation_id": "ext-123",
"context": "Customer is requesting a refund and is frustrated."
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List all redirects for a help center — intercom.listhelpcenterredirects
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.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.help_center_id |
string | Required | The unique identifier for the help center. | |
query |
object | Optional | additionalProperties: false |
|
query.page |
integer | Optional | The page of results to fetch. Defaults to the first page. | |
query.per_page |
integer | Optional | The number of results to return per page. Defaults to 50, maximum 250. | |
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
Full JSON Schema
Example input
{
"path": {
"help_center_id": "123"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a redirect — intercom.createhelpcenterredirect
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.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.help_center_id |
string | Required | The unique identifier for the help center. | |
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
body |
— | Optional | $ref: "#/definitions/create_help_center_redirect_request" |
Full JSON Schema
Example input
{
"path": {
"help_center_id": "123"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a redirect — intercom.retrievehelpcenterredirect
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}.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.help_center_id |
string | Required | The unique identifier for the help center. | |
path.id |
string | Required | The unique identifier for the redirect. | |
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
Full JSON Schema
Example input
{
"path": {
"help_center_id": "123",
"id": "26"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete a redirect — intercom.deletehelpcenterredirect
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}.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.help_center_id |
string | Required | The unique identifier for the help center. | |
path.id |
string | Required | The unique identifier for the redirect. | |
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
Full JSON Schema
Example input
{
"path": {
"help_center_id": "123",
"id": "26"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List all collections — intercom.listallcollections
You can fetch a list of all collections by making a GET request to https://api.intercom.io/help_center/collections.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
query |
object | Optional | additionalProperties: false |
|
query.page |
integer | Optional | The page of results to fetch. Defaults to the first page. | |
query.per_page |
integer | Optional | The number of results to return per page. Defaults to 20. Maximum is 250. | maximum: 250 |
query.help_center_id |
integer | Optional | Only return collections that belong to this Help Center. |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a collection — intercom.createcollection
You can create a new collection by making a POST request to https://api.intercom.io/help_center/collections.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
body |
— | Optional | $ref: "#/definitions/create_collection_request" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a collection — intercom.retrievecollection
You can fetch the details of a single collection by making a GET request to https://api.intercom.io/help_center/collections/<id>.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.collection_id |
integer | Required | The unique identifier for the collection which is given by Intercom. |
Full JSON Schema
Example input
{
"path": {
"collection_id": 123
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update a collection — intercom.updatecollection
You can update the details of a single collection by making a PUT request to https://api.intercom.io/help_center/collections/<id>.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.collection_id |
integer | Required | The unique identifier for the collection which is given by Intercom. | |
body |
— | Optional | $ref: "#/definitions/update_collection_request" |
Full JSON Schema
Example input
{
"path": {
"collection_id": 123
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete a collection — intercom.deletecollection
You can delete a single collection by making a DELETE request to https://api.intercom.io/help_center/collections/<id>.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.collection_id |
integer | Required | The unique identifier for the collection which is given by Intercom. |
Full JSON Schema
Example input
{
"path": {
"collection_id": 123
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a Help Center — intercom.retrievehelpcenter
You can fetch the details of a single Help Center by making a GET request to https://api.intercom.io/help_center/help_centers/<id>.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.help_center_id |
integer | Required | The unique identifier for the Help Center which is given by Intercom. |
Full JSON Schema
Example input
{
"path": {
"help_center_id": 123
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List all Help Centers — intercom.listhelpcenters
You can list all Help Centers by making a GET request to https://api.intercom.io/help_center/help_centers.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
List all articles — intercom.listinternalarticles
You can fetch a list of all internal articles by making a GET request to https://api.intercom.io/internal_articles.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
query |
object | Optional | additionalProperties: false |
|
query.page |
integer | Optional | The page of results to fetch. Defaults to 1. | |
query.per_page |
integer | Optional | The number of results to return per page. Defaults to 50. |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create an internal article — intercom.createinternalarticle
You can create a new internal article by making a POST request to https://api.intercom.io/internal_articles.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
body |
— | Optional | $ref: "#/definitions/create_internal_article_request" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve an internal article — intercom.retrieveinternalarticle
You can fetch the details of a single internal article by making a GET request to https://api.intercom.io/internal_articles/<id>.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.internal_article_id |
integer | Required | The unique identifier for the article which is given by Intercom. |
Full JSON Schema
Example input
{
"path": {
"internal_article_id": 123
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update an internal article — intercom.updateinternalarticle
You can update the details of a single internal article by making a PUT request to https://api.intercom.io/internal_articles/<id>.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.internal_article_id |
integer | Required | The unique identifier for the internal article which is given by Intercom. | |
body |
— | Optional | $ref: "#/definitions/update_internal_article_request" |
Full JSON Schema
Example input
{
"path": {
"internal_article_id": 123
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete an internal article — intercom.deleteinternalarticle
You can delete a single internal article by making a DELETE request to https://api.intercom.io/internal_articles/<id>.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.internal_article_id |
integer | Required | The unique identifier for the internal article which is given by Intercom. |
Full JSON Schema
Example input
{
"path": {
"internal_article_id": 123
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Add a tag to an internal article — intercom.attachtagtointernalarticle
Apply an existing tag to an internal article. Returns the tag that was applied.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.internal_article_id |
integer | Required | The unique identifier for the internal article which is given by Intercom. | |
body |
object | Optional | ||
body.id |
string | Required | The unique identifier of the tag to apply, as given by Intercom. | |
body.admin_id |
string | null | Optional | Optional id of the teammate to attribute the tagging to. Defaults to the authenticating teammate. Does not affect authorization. |
Full JSON Schema
Example input
{
"path": {
"internal_article_id": 123
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Remove a tag from an internal article — intercom.detachtagfrominternalarticle
Remove a tag from an internal article. Returns the tag that was removed, with null applied_at and applied_by.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.internal_article_id |
integer | Required | The unique identifier for the internal article which is given by Intercom. | |
path.id |
string | Required | The unique identifier of the tag to remove, as given by Intercom. | |
query |
object | Optional | additionalProperties: false |
|
query.admin_id |
string | Optional | Optional id of a teammate. The id is checked, and an unknown teammate returns a 404 admin_not_found error, but the removal is not recorded against the teammate. |
Full JSON Schema
Example input
{
"path": {
"internal_article_id": 123,
"id": "7522907"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Search for internal articles — intercom.searchinternalarticles
You can search for internal articles by making a GET request to https://api.intercom.io/internal_articles/search.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
query |
object | Optional | additionalProperties: false |
|
query.folder_id |
integer | Optional | The ID of the folder to search in. Results will include articles from this folder and all its descendant folders. If omitted or blank, the response is an empty list. | |
query.page |
integer | Optional | The page of results to fetch. Defaults to 1. | |
query.per_page |
integer | Optional | The number of results to return per page. Defaults to 10. |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
List all folders — intercom.listfolders
You can fetch a list of all folders for organizing content by making a GET request to https://api.intercom.io/folders.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
query |
object | Optional | additionalProperties: false |
|
query.page |
integer | Optional | The page number | |
query.per_page |
integer | Optional | Number of results per page | |
query.parent_folder_id |
integer | Optional | Filter folders by parent folder ID. Use this to list only direct children of a specific folder. |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a folder — intercom.createfolder
You can create a new folder for organizing content by making a POST request to https://api.intercom.io/folders.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
body |
object | Optional | ||
body.folder |
object | Required | ||
body.folder.name |
string | Required | The name of the folder | |
body.folder.description |
string | Optional | The description of the folder | |
body.folder.emoji |
string | Optional | An emoji for the folder | |
body.folder.parent_folder_id |
integer | null | Optional | The ID of the parent folder |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a folder — intercom.retrievefolder
You can fetch the details of a single folder by making a GET request to https://api.intercom.io/folders/<id>.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.id |
integer | Required | The unique identifier for the folder |
Full JSON Schema
Example input
{
"path": {
"id": 6
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update a folder — intercom.updatefolder
You can update a folder by making a PUT request to https://api.intercom.io/folders/<id>.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.id |
integer | Required | The unique identifier for the folder | |
body |
object | Optional | ||
body.folder |
object | Required | ||
body.folder.name |
string | Optional | The name of the folder | |
body.folder.description |
string | Optional | The description of the folder | |
body.folder.emoji |
string | Optional | An emoji for the folder | |
body.folder.parent_folder_id |
integer | null | Optional | The ID of the parent folder. Send null to move the folder to the top level. If omitted, the parent folder is unchanged. |
Full JSON Schema
Example input
{
"path": {
"id": 6
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete a folder — intercom.deletefolder
You can delete a folder (if it contains no content) by making a DELETE request to https://api.intercom.io/folders/<id>.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.id |
integer | Required | The unique identifier for the folder |
Full JSON Schema
Example input
{
"path": {
"id": 6
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get IP allowlist settings — intercom.getipallowlist
Retrieve the current IP allowlist configuration for the workspace.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update IP allowlist settings — intercom.updateipallowlist
Update the IP allowlist configuration for the workspace.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
body |
— | Optional | $ref: "#/definitions/ip_allowlist" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create or Update a company — intercom.createorupdatecompany
You can create or update a company.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
body |
— | Optional | $ref: "#/definitions/create_or_update_company_request" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve companies — intercom.retrievecompany
You can fetch a single company by passing in company_id or name.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
query |
object | Optional | additionalProperties: false |
|
query.name |
string | Optional | The name of the company to filter by. |
|
query.company_id |
string | Optional | The company_id of the company to filter by. |
|
query.tag_id |
string | Optional | The tag_id of the company to filter by. |
|
query.segment_id |
string | Optional | The segment_id of the company to filter by. |
|
query.type |
string | Optional | Set to user or users, together with company_id or name, to return that company's users instead of the company. The response is then a user.list object with a users array in the legacy user format, paged with page and per_page (default 50). |
enum: ["user","users"] |
query.page |
integer | Optional | The page of results to fetch. Defaults to first page | |
query.per_page |
integer | Optional | How many results to display per page. Defaults to 15. A value above 60 returns a 400 error with code parameter_invalid. |
maximum: 60 |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a company by ID — intercom.retrieveacompanybyid
You can fetch a single company.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.company_id |
string | Required | The unique identifier for the company which is given by Intercom | |
query |
object | Optional | additionalProperties: false |
|
query.type |
string | Optional | Set to user or users to return the company's users instead of the company. The response is then a user.list object with a users array in the legacy user format. |
enum: ["user","users"] |
query.page |
integer | Optional | The page of users to fetch. Used only when type is user or users. Defaults to first page. There is a limit of 10,000 users; a page and per_page that go past it return a 400 error with code bad_request. |
|
query.per_page |
integer | Optional | How many users to return per page. Used only when type is user or users. Defaults to 50. A value above 60 returns a 400 error with code parameter_invalid. |
maximum: 60 |
Full JSON Schema
Example input
{
"path": {
"company_id": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update a company — intercom.updatecompany
You can update a single company using the Intercom provisioned id.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.company_id |
string | Required | The unique identifier for the company which is given by Intercom | |
body |
— | Optional | $ref: "#/definitions/update_company_request" |
Full JSON Schema
Example input
{
"path": {
"company_id": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete a company — intercom.deletecompany
Delete a single company.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.company_id |
string | Required | The unique identifier for the company which is given by Intercom |
Full JSON Schema
Example input
{
"path": {
"company_id": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List attached contacts — intercom.listattachedcontacts
You can fetch a list of all contacts that belong to a company.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.company_id |
string | Required | The unique identifier for the company which is given by Intercom | |
query |
object | Optional | additionalProperties: false |
|
query.per_page |
integer | Optional | How many contacts to return per page. Defaults to 50. | |
query.starting_after |
string | Optional | The cursor to fetch the next page of contacts. Use the starting_after value from pages.next in the previous response. |
|
query.include_merge_history |
string | Optional | Set to true to include each contact's merge_history. Any other value omits it. |
Full JSON Schema
Example input
{
"path": {
"company_id": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List attached segments for companies — intercom.listattachedsegmentsforcompanies
You can fetch a list of all segments that belong to a company.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.company_id |
string | Required | The unique identifier for the company which is given by Intercom |
Full JSON Schema
Example input
{
"path": {
"company_id": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List all company notes — intercom.listcompanynotes
You can fetch a list of notes that are associated to a company.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.company_id |
string | Required | The unique identifier for the company which is given by Intercom | |
query |
object | Optional | additionalProperties: false |
|
query.page |
integer | Optional | The page of results to return. Defaults to 1. |
|
query.per_page |
integer | Optional | The number of notes to return per page. Defaults to 50, maximum 60. |
|
query.order |
string | Optional | The order the notes are returned in, by id. Defaults to desc. |
enum: ["asc","desc"] |
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
Full JSON Schema
Example input
{
"path": {
"company_id": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a company note — intercom.createcompanynote
You can add a note to a single company.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.company_id |
string | Required | The unique identifier for the company which is given by Intercom | |
body |
object | Optional | ||
body.body |
string | Required | The text of the note. | |
body.admin_id |
string | Optional | The unique identifier of the admin creating the note. If not provided, defaults to the admin associated with the access token. |
Full JSON Schema
Example input
{
"path": {
"company_id": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Search companies — intercom.searchcompanies
You can search for companies by the value of their attributes in order to fetch exactly the companies you want.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
body |
— | Optional | $ref: "#/definitions/company_search_request" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
List all companies — intercom.listallcompanies
You can list companies. The company list is sorted by the last_request_at field and by default is ordered descending, most recently requested first.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
query |
object | Optional | additionalProperties: false |
|
query.page |
integer | Optional | The page of results to fetch. Defaults to first page | |
query.per_page |
integer | Optional | How many results to return per page. Defaults to 15. A value above 60 returns a 400 error with code parameter_invalid. |
maximum: 60 |
query.order |
string | Optional | asc or desc. Return the companies in ascending or descending order. Defaults to desc. Any other value returns a 400 error with code parameter_invalid. |
enum: ["asc","desc"] |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Scroll over all companies — intercom.scrolloverallcompanies
The list all companies functionality does not work well for huge datasets, and can result in errors and performance problems when paging deeply. The Scroll API provides an efficient mechanism for iterating over all companies in a dataset.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
query |
object | Optional | additionalProperties: false |
|
query.scroll_param |
string | Optional | The scroll_param from the previous response. Omit it to start a new scroll. |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Attach a Contact to a Company — intercom.attachcontacttoacompany
You can attach a company to a single contact.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.contact_id |
string | Required | The unique identifier for the contact which is given by Intercom | |
body |
object | Optional | ||
body.id |
string | Required | The unique identifier for the company which is given by Intercom |
Full JSON Schema
Example input
{
"path": {
"contact_id": "58a430d35458202d41b1e65b"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List attached companies for contact — intercom.listcompaniesforacontact
You can fetch a list of companies that are associated to a contact.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.contact_id |
string | Required | The unique identifier for the contact which is given by Intercom | |
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
query |
object | Optional | additionalProperties: false |
|
query.page |
integer | Optional | The page of results to fetch. Values below 1 are treated as 1. | default: 1 |
query.per_page |
integer | Optional | The number of companies to return per page. The maximum is 60; a value above 60 returns a 400 error with code parameter_invalid. |
default: 50; maximum: 60 |
query.order |
string | Optional | The order of the companies by when they were last active (last_request_at). The value is case-insensitive, and any value other than asc is treated as desc. |
enum: ["asc","desc"]; default: "desc" |
Full JSON Schema
Example input
{
"path": {
"contact_id": "63a07ddf05a32042dffac965"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Detach a contact from a company — intercom.detachcontactfromacompany
You can detach a company from a single contact.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.contact_id |
string | Required | The unique identifier for the contact which is given by Intercom | |
path.company_id |
string | Required | The unique identifier for the company which is given by Intercom |
Full JSON Schema
Example input
{
"path": {
"contact_id": "58a430d35458202d41b1e65b",
"company_id": "58a430d35458202d41b1e65b"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List all notes — intercom.listnotes
You can fetch a list of notes that are associated to a contact.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.contact_id |
string | Required | The unique identifier of a contact. | |
query |
object | Optional | additionalProperties: false |
|
query.page |
integer | Optional | The page of results to return. Defaults to 1. |
|
query.per_page |
integer | Optional | The number of notes to return per page. Defaults to 50, maximum 60. |
|
query.order |
string | Optional | The order the notes are returned in, by id. Defaults to desc. |
enum: ["asc","desc"] |
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
Full JSON Schema
Example input
{
"path": {
"contact_id": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a note — intercom.createnote
You can add a note to a single contact.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.contact_id |
string | Required | The unique identifier of a given contact. | |
body |
object | Optional | ||
body.body |
string | Required | The text of the note. | |
body.admin_id |
string | Optional | The unique identifier of a given admin. |
Full JSON Schema
Example input
{
"path": {
"contact_id": "6762f0ad1bb69f9f2193bb62"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List attached segments for contact — intercom.listsegmentsforacontact
You can fetch a list of segments that are associated to a contact.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.contact_id |
string | Required | The unique identifier for the contact which is given by Intercom | |
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
Full JSON Schema
Example input
{
"path": {
"contact_id": "63a07ddf05a32042dffac965"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List subscriptions for a contact — intercom.listsubscriptionsforacontact
You can fetch a list of subscription types that are attached to a contact. These can be subscriptions that a user has 'opted-in' to or has 'opted-out' from, depending on the subscription type. This will return a list of Subscription Type objects that the contact is associated with.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.contact_id |
string | Required | The unique identifier for the contact which is given by Intercom | |
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
Full JSON Schema
Example input
{
"path": {
"contact_id": "63a07ddf05a32042dffac965"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Add subscription to a contact — intercom.attachsubscriptiontypetocontact
You can add a specific subscription to a contact. In Intercom, we have two different subscription types based on user consent - opt-out and opt-in:
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.contact_id |
string | Required | The unique identifier for the contact which is given by Intercom | |
body |
object | Optional | ||
body.id |
string | Required | The unique identifier for the subscription which is given by Intercom | |
body.consent_type |
string | Optional | Ignored. Whether the contact is opted in or out is decided by the subscription type's own consent_type, not by this value. |
Full JSON Schema
Example input
{
"path": {
"contact_id": "63a07ddf05a32042dffac965"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Remove subscription from a contact — intercom.detachsubscriptiontypetocontact
You can remove a specific subscription from a contact. This will return a subscription type model for the subscription type that was removed from the contact.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.contact_id |
string | Required | The unique identifier for the contact which is given by Intercom | |
path.subscription_id |
string | Required | The unique identifier for the subscription type which is given by Intercom |
Full JSON Schema
Example input
{
"path": {
"contact_id": "63a07ddf05a32042dffac965",
"subscription_id": "37846"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Add tag to a contact — intercom.attachtagtocontact
You can tag a specific contact. This will return a tag object for the tag that was added to the contact.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.contact_id |
string | Required | The unique identifier for the contact which is given by Intercom | |
body |
object | Optional | ||
body.id |
string | Required | The unique identifier for the tag which is given by Intercom |
Full JSON Schema
Example input
{
"path": {
"contact_id": "63a07ddf05a32042dffac965"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Remove tag from a contact — intercom.detachtagfromcontact
You can remove tag from a specific contact. This will return a tag object for the tag that was removed from the contact.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.contact_id |
string | Required | The unique identifier for the contact which is given by Intercom | |
path.tag_id |
string | Required | The unique identifier for the tag which is given by Intercom |
Full JSON Schema
Example input
{
"path": {
"contact_id": "63a07ddf05a32042dffac965",
"tag_id": "7522907"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List deleted contacts — intercom.listdeletedcontacts
Fetch a paginated list of the contacts in your workspace that are no longer active, so you can recover ones whose id, email, or external_id you no longer have and then permanently delete them. Each entry carries a status describing why the contact is inactive: archived, blocked, merged, pending_deletion, or permanently_deleted. merged_into_id is present only when status is merged, and external_id and email are null for permanently_deleted contacts.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
query |
object | Optional | additionalProperties: false |
|
query.per_page |
integer | Optional | The number of results per page. Defaults to 10, with a maximum of 150; larger values are treated as 150. Only the leading digits are read, so 1.5 is treated as 1. A value that doesn't start with a positive integer, such as 0 or abc, returns a 400 error with code invalid_per_page. |
default: 10; minimum: 1; maximum: 150 |
query.page |
integer | Optional | The page of results to fetch. Defaults to 1. |
default: 1; minimum: 1 |
query.escape_identity |
boolean | Optional | By default, email values in the response are HTML-escaped (for example, & is returned as &). Pass false to return them unescaped. |
default: true |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update a contact — intercom.updatecontact
You can update an existing contact (ie. user or lead).
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.contact_id |
string | Required | id | |
query |
object | Optional | additionalProperties: false |
|
query.include_merge_history |
boolean | Optional | Pass true to include the contact's merge history in the response. Returned for contacts of any role, with at most the 10 most recent merges. |
default: false |
body |
— | Optional | ||
body |
— | Optional | oneOf[1]; $ref: "#/definitions/update_contact_request" |
Full JSON Schema
Example input
{
"path": {
"contact_id": "63a07ddf05a32042dffac965"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get a contact — intercom.showcontact
You can fetch the details of a single contact.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.contact_id |
string | Required | contact_id | |
query |
object | Optional | additionalProperties: false |
|
query.include_merge_history |
boolean | Optional | Pass true to include the contact's merge history in the response. Returned for contacts of any role, with at most the 10 most recent merges. |
default: false |
query.escape_identity |
boolean | Optional | By default, name and email values in the response, including nested ones such as social profile names, are HTML-escaped (for example, & is returned as &). Custom attributes and tags are never escaped. Pass false to return them unescaped. |
default: true |
Full JSON Schema
Example input
{
"path": {
"contact_id": "63a07ddf05a32042dffac965"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete a contact — intercom.deletecontact
You can delete a single contact.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.contact_id |
string | Required | contact_id |
Full JSON Schema
Example input
{
"path": {
"contact_id": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Merge a lead and a user — intercom.mergecontact
You can merge a contact with a role of lead into a contact with a role of user.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
query |
object | Optional | additionalProperties: false |
|
query.include_merge_history |
boolean | Optional | Pass true to include the merge history of the resulting contact in the response, with at most the 10 most recent merges. |
default: false |
body |
— | Optional | $ref: "#/definitions/merge_contacts_request" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Preview a contact merge — intercom.previewmergecontact
Preview the result of merging one contact into another without applying the merge. This is a read-only dry run: it reports whether the merge is allowed and, if so, exactly what would change, without modifying any data.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
body |
— | Optional | $ref: "#/definitions/merge_preview_request" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Search contacts — intercom.searchcontacts
You can search for multiple contacts by the value of their attributes in order to fetch exactly who you want.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
query |
object | Optional | additionalProperties: false |
|
query.include_merge_history |
boolean | Optional | Pass true in the query string to include a merge_history array on each contact in the response; a JSON boolean in the request body is ignored. Returned for contacts of any role, with at most the 10 most recent merges. |
default: false |
query.escape_identity |
boolean | Optional | By default, name and email values in the response, including nested ones such as social profile names, are HTML-escaped (for example, & is returned as &). Custom attributes and tags are never escaped. Pass false to return them unescaped. |
default: true |
body |
— | Optional | $ref: "#/definitions/contact_search_request" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
List all contact activities — intercom.listcontactactivities
You can fetch a list of contact activity events for your workspace, such as when contacts are created, role updated, merged, or deleted. Events are returned oldest first.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
query |
object | Optional | additionalProperties: false |
|
query.per_page |
integer | Optional | The number of results to return per page. Defaults to 50, minimum 1, maximum 150; larger values are treated as 150. Only the leading digits are read, so 1.5 is treated as 1. A value that doesn't start with a positive integer, such as 0 or abc, returns a 400 error with code invalid_per_page. |
default: 50; minimum: 1; maximum: 150 |
query.starting_after |
string | Optional | The cursor value from pages.next.starting_after in a previous response. Used to paginate through results. |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
List all contacts — intercom.listcontacts
You can fetch a list of all contacts (ie. users or leads) in your workspace. {% admonition type="info" name="Merged contacts" %} Contacts that have been merged (via POST /contacts/merge) will not appear in list results. Only the target contact from the merge remains accessible. {% /admonition %} {% admonition type="warning" name="Pagination" %} You can use pagination to limit the number of results returned. The default is 10 results per page, with a maximum of 150. See the pagination section for more details on how to use the starting_after param. {% /admonition %}
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
query |
object | Optional | additionalProperties: false |
|
query.include_merge_history |
boolean | Optional | Pass true to include a merge_history array on each contact in the response. Returned for contacts of any role, with at most the 10 most recent merges. |
default: false |
query.escape_identity |
boolean | Optional | By default, name and email values in the response, including nested ones such as social profile names, are HTML-escaped (for example, & is returned as &). Custom attributes and tags are never escaped. Pass false to return them unescaped. |
default: true |
query.per_page |
integer | Optional | The number of results per page. Defaults to 10, with a maximum of 150; larger values are treated as 150. Only the leading digits are read, so 1.5 is treated as 1. A value that doesn't start with a positive integer, such as 0 or abc, returns a 400 error with code invalid_per_page. |
default: 10; minimum: 1; maximum: 150 |
query.starting_after |
string | Optional | The cursor value from pages.next.starting_after in a previous response. An empty value is ignored. A value that isn't a valid cursor returns a 400 error with code client_error. |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create contact — intercom.createcontact
You can create a new contact (ie. user or lead).
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
body |
— | Optional | ||
body |
— | Optional | oneOf[1]; $ref: "#/definitions/create_contact_request" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get a contact by External ID — intercom.showcontactbyexternalid
You can fetch the details of a single contact by external ID. Note that this endpoint only supports users and not leads.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.external_id |
string | Required | The external ID of the user that you want to retrieve | |
query |
object | Optional | additionalProperties: false |
|
query.include_merge_history |
boolean | Optional | Pass true to include the contact's merge history in the response. Returned for contacts of any role, with at most the 10 most recent merges. |
default: false |
query.escape_identity |
boolean | Optional | By default, name and email values in the response, including nested ones such as social profile names, are HTML-escaped (for example, & is returned as &). Custom attributes and tags are never escaped. Pass false to return them unescaped. |
default: true |
Full JSON Schema
Example input
{
"path": {
"external_id": "cdd29344-5e0c-4ef0-ac56-f9ba2979bc27"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Archive contact — intercom.archivecontact
You can archive a single contact.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.contact_id |
string | Required | contact_id |
Full JSON Schema
Example input
{
"path": {
"contact_id": "63a07ddf05a32042dffac965"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Unarchive contact — intercom.unarchivecontact
You can unarchive a single contact.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.contact_id |
string | Required | contact_id |
Full JSON Schema
Example input
{
"path": {
"contact_id": "63a07ddf05a32042dffac965"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Block contact — intercom.blockcontact
Block a single contact. Note: conversations of the contact will also be archived during the process. More details in FAQ How do I block Inbox spam?
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.contact_id |
string | Required | contact_id |
Full JSON Schema
Example input
{
"path": {
"contact_id": "63a07ddf05a32042dffac965"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get contact merge history — intercom.listcontactmergehistory
Retrieve the paginated list of contacts that have been merged into a given contact.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The id of the contact to fetch merge history for. | |
query |
object | Optional | additionalProperties: false |
|
query.cursor |
string | Optional | A cursor for pagination. Pass the next_cursor value from a previous response to fetch the next page. |
|
query.per_page |
integer | Optional | The number of results to return per page (default 50, max 150). A value outside 1–150 returns a 422 error. |
default: 50; minimum: 1; maximum: 150 |
query.order |
string | Optional | The order to return results in. Defaults to descending. Any other value returns a 422 error. |
enum: ["asc","desc"] |
Full JSON Schema
Example input
{
"path": {
"id": "63a07ddf05a32042dffac965"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Bulk create contacts — intercom.bulkcreatecontacts
You can bulk create contacts by submitting an array of contact objects. This is a strict create and never updates an existing contact.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
body |
— | Optional | $ref: "#/definitions/bulk_create_contacts_request" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Bulk update contacts — intercom.bulkupdatecontacts
You can bulk update contacts by submitting an array of contact objects with the fields to update. Each contact must include an id field identifying the contact to update. You can also add or remove tags on each contact by including a tags object.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
body |
— | Optional | $ref: "#/definitions/bulk_update_contacts_request" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Bulk delete contacts — intercom.bulkdeletecontacts
You can delete contacts in bulk by submitting an array of contact ids.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
body |
— | Optional | $ref: "#/definitions/bulk_delete_contacts_request" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get a bulk update job — intercom.showbulkupdatecontactsjob
You can check the status of a bulk contact update job. The state field indicates the overall job progress: running, completed, or completed_with_errors.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The unique identifier for the bulk job. |
Full JSON Schema
Example input
{
"path": {
"id": "job_v2_1"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Run a bulk action on Knowledge Hub content — intercom.bulkcontentactions
Asynchronously run a bulk action over up to 1,000 Knowledge Hub content items.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
body |
— | Required | $ref: "#/definitions/content_bulk_action_request" |
Full JSON Schema
Example input
{
"body": {
"action": "publish",
"content_ids": []
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Search knowledge base contents — intercom.searchcontent
Search the knowledge base contents — articles, snippets, external pages, uploaded files, and internal articles — using a keyword query.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
query |
object | Optional | additionalProperties: false |
|
query.query |
string | Optional | A free-text search term matched against the title and body of each content item. When omitted, returns the most recent content items. Keep it to 500 characters or fewer. The API doesn't currently reject longer values. | maxLength: 500 |
query.page |
integer | Optional | The page number to fetch. Defaults to 1. Values below 1 are clamped to 1. Values above 5001 return a 400 parameter_invalid error. |
default: 1; minimum: 1 |
query.per_page |
integer | Optional | Number of results per page. Defaults to 10. Maximum 50. | default: 10; minimum: 1; maximum: 50 |
query.states |
array | Optional | Filter by publication state. Accepts a comma-separated list or repeated params. | |
query.states[] |
string | Optional | enum: ["published","draft"] |
|
query.locales |
array | Optional | Filter by locale codes (e.g. en, fr, de). Accepts a comma-separated list or repeated params. |
|
query.locales[] |
string | Optional | ||
query.tag_ids |
array | Optional | Filter by tag IDs. Pairs with tag_operator to control match semantics. Accepts a comma-separated list or repeated params. |
|
query.tag_ids[] |
integer | Optional | ||
query.tag_operator |
string | Optional | Match operator paired with tag_ids. IN returns content matching any of the given tags; NIN excludes content matching any of them. |
enum: ["IN","NIN"] |
query.any_tag_ids |
array | Optional | Filter by tag IDs using OR semantics — returns content matching any of the given tags. Alternative to tag_ids + tag_operator. Accepts a comma-separated list or repeated params. |
|
query.any_tag_ids[] |
integer | Optional | ||
query.folder_ids |
array | Optional | Filter by folder IDs. Must be sent together with folder_entity_type. Accepts a comma-separated list or repeated params. |
|
query.folder_ids[] |
integer | Optional | ||
query.folder_entity_type |
string | Optional | Required when folder_ids is provided. Identifies the entity type the folder IDs refer to. |
enum: ["folder"] |
query.content_types |
array | Optional | Restrict the search to specific content types. When provided, this REPLACES the default content type set rather than filtering on top of it. Accepts a comma-separated list or repeated params. | |
query.content_types[] |
string | Optional | enum: ["snippet","external_content","file_source_content","internal_article","article"] |
|
query.copilot_state |
string | Optional | Filter by whether the content is enabled for Copilot. | enum: ["on","off"] |
query.fin_service_state |
string | Optional | Filter by whether the content is enabled for Fin AI Agent (customer-facing service). | enum: ["on","off"] |
query.fin_sales_state |
string | Optional | Filter by whether the content is enabled for Fin Sales Agent. | enum: ["on","off"] |
query.created_by_ids |
array | Optional | Filter by the admin IDs that created the content. Accepts a comma-separated list or repeated params. | |
query.created_by_ids[] |
integer | Optional | ||
query.last_updated_by_ids |
array | Optional | Filter by the admin IDs that last updated the content. Accepts a comma-separated list or repeated params. | |
query.last_updated_by_ids[] |
integer | Optional | ||
query.created_at_after |
integer | Optional | Return content created at or after this time. Unix epoch seconds. | |
query.created_at_before |
integer | Optional | Return content created at or before this time. Unix epoch seconds. | |
query.updated_at_after |
integer | Optional | Return content last updated at or after this time. Unix epoch seconds. | |
query.updated_at_before |
integer | Optional | Return content last updated at or before this time. Unix epoch seconds. |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
List all content snippets — intercom.listcontentsnippets
You can fetch a list of all content snippets for a workspace.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
query |
object | Optional | additionalProperties: false |
|
query.page |
integer | Optional | The page of results to fetch. | |
query.per_page |
integer | Optional | The number of results to return per page. Max value of 50. |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a content snippet — intercom.createcontentsnippet
You can create a new content snippet.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
body |
— | Required | $ref: "#/definitions/content_snippet_create_request" |
Full JSON Schema
Example input
{
"body": {
"title": "How to reset your password"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a content snippet — intercom.getcontentsnippet
You can fetch a single content snippet by its id.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The unique identifier for the content snippet. |
Full JSON Schema
Example input
{
"path": {
"id": "123"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update a content snippet — intercom.updatecontentsnippet
You can update an existing content snippet.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The unique identifier for the content snippet. | |
body |
— | Required | $ref: "#/definitions/content_snippet_update_request" |
Full JSON Schema
Example input
{
"path": {
"id": "123"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete a content snippet — intercom.deletecontentsnippet
You can delete a single content snippet by its id.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The unique identifier for the content snippet. |
Full JSON Schema
Example input
{
"path": {
"id": "123"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Add a tag to a content snippet — intercom.attachtagtocontentsnippet
Apply an existing tag to a content snippet. Returns the tag that was applied.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.content_snippet_id |
string | Required | The unique identifier for the content snippet. | |
body |
object | Optional | ||
body.id |
string | Required | The unique identifier of the tag to apply, as given by Intercom. | |
body.admin_id |
string | null | Optional | Optional id of the teammate to attribute the tagging to. Defaults to the authenticating teammate. Does not affect authorization. |
Full JSON Schema
Example input
{
"path": {
"content_snippet_id": "123"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Remove a tag from a content snippet — intercom.detachtagfromcontentsnippet
Remove a tag from a content snippet. Returns the tag that was removed, with null applied_at and applied_by.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.content_snippet_id |
string | Required | The unique identifier for the content snippet. | |
path.id |
string | Required | The unique identifier of the tag to remove, as given by Intercom. | |
query |
object | Optional | additionalProperties: false |
|
query.admin_id |
string | Optional | Optional id of a teammate. The id is checked, and an unknown teammate returns a 404 admin_not_found error, but the removal is not recorded against the teammate. |
Full JSON Schema
Example input
{
"path": {
"content_snippet_id": "123",
"id": "7522907"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List all dynamic content — intercom.listdynamiccontents
You can fetch a list of all dynamic content for a workspace, most recently updated first.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
query |
object | Optional | additionalProperties: false |
|
query.page |
integer | Optional | The page of results to fetch. Defaults to the first page. Values below 1 are treated as 1. | |
query.per_page |
integer | Optional | The number of results to return per page. Defaults to 50. Values above 50 are reduced to 50, and values below 1 are treated as 1. | maximum: 50 |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create dynamic content — intercom.createdynamiccontent
You can create dynamic content.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
body |
— | Required | $ref: "#/definitions/dynamic_content_create_request" |
Full JSON Schema
Example input
{
"body": {
"name": "Support phone number",
"content_type": "inline",
"default_locale": "en",
"variations": [
{
"locale": "en"
}
]
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve dynamic content — intercom.getdynamiccontent
You can fetch a single dynamic content by its id.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The unique identifier for the dynamic content. |
Full JSON Schema
Example input
{
"path": {
"id": "123"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update dynamic content — intercom.updatedynamiccontent
You can update existing dynamic content. Only the fields you provide are changed.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The unique identifier for the dynamic content. | |
body |
— | Required | $ref: "#/definitions/dynamic_content_update_request" |
Full JSON Schema
Example input
{
"path": {
"id": "123"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete dynamic content — intercom.deletedynamiccontent
You can delete a single dynamic content by its id. Dynamic content that is still used in an article can't be deleted.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The unique identifier for the dynamic content. |
Full JSON Schema
Example input
{
"path": {
"id": "123"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Add tag to a conversation — intercom.attachtagtoconversation
You can tag a specific conversation. This will return a tag object for the tag that was added to the conversation.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.conversation_id |
string | Required | conversation_id | |
body |
object | Optional | ||
body.id |
string | Required | The unique identifier for the tag which is given by Intercom | |
body.admin_id |
string | Required | The unique identifier for the admin which is given by Intercom. |
Full JSON Schema
Example input
{
"path": {
"conversation_id": "64619700005694"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Remove tag from a conversation — intercom.detachtagfromconversation
You can remove tag from a specific conversation. This will return a tag object for the tag that was removed from the conversation.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.conversation_id |
string | Required | conversation_id | |
path.tag_id |
string | Required | tag_id | |
body |
object | Optional | ||
body.admin_id |
string | Required | The unique identifier for the admin which is given by Intercom. |
Full JSON Schema
Example input
{
"path": {
"conversation_id": "64619700005694",
"tag_id": "7522907"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List all conversations — intercom.listconversations
You can fetch a list of all conversations.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
query |
object | Optional | additionalProperties: false |
|
query.per_page |
integer | Optional | How many results per page | default: 20; maximum: 150 |
query.starting_after |
string | Optional | String used to get the next page of conversations. | |
query.include_monitors |
boolean | Optional | If set to true, the response will include a monitor_evaluations array on each conversation with the latest QA monitor evaluation for each monitor that has evaluated it. |
default: false |
query.include_scorecards |
boolean | Optional | If set to true, the response will include a scorecards array on each conversation with any QA scorecard results. |
default: false |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Creates a conversation — intercom.createconversation
You can create a conversation that has been initiated by a contact (ie. user or lead). The conversation can be an in-app message only.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
body |
— | Optional | $ref: "#/definitions/create_conversation_request" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a conversation — intercom.retrieveconversation
You can fetch the details of a single conversation.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.conversation_id |
integer | Required | The id of the conversation to target | |
query |
object | Optional | additionalProperties: false |
|
query.display_as |
string | Optional | Set to plaintext to retrieve conversation messages in plain text. This affects both the body and subject fields. Inline links are rendered as label (url), preserving the link URL alongside the visible text. |
|
query.include_translations |
boolean | Optional | If set to true, conversation parts will be translated to the detected language of the conversation. | |
query.include_email_history |
boolean | Optional | If set to true, the source of the conversation will include the email history, for conversations started by email. | |
query.parts_created_after |
integer | Optional | Only include conversation parts created at or after this time, as a Unix timestamp in seconds. | |
query.parts_created_before |
integer | Optional | Only include conversation parts created at or before this time, as a Unix timestamp in seconds. | |
query.include_monitors |
boolean | Optional | If set to true, the response will include a monitor_evaluations array with the latest QA monitor evaluation for each monitor that has evaluated this conversation. |
default: false |
query.include_scorecards |
boolean | Optional | If set to true, the response will include a scorecards array with any QA scorecard results for this conversation. |
default: false |
Full JSON Schema
Example input
{
"path": {
"conversation_id": 123
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update a conversation — intercom.updateconversation
You can update an existing conversation.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.conversation_id |
integer | Required | The id of the conversation to target | |
query |
object | Optional | additionalProperties: false |
|
query.display_as |
string | Optional | Set to plaintext to retrieve conversation messages in plain text. This affects both the body and subject fields. Inline links are rendered as label (url), preserving the link URL alongside the visible text. |
|
body |
— | Optional | $ref: "#/definitions/update_conversation_request" |
Full JSON Schema
Example input
{
"path": {
"conversation_id": 123
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete a conversation — intercom.deleteconversation
{% admonition type="warning" name="Irreversible operation" %} Deleting a conversation is permanent and cannot be reversed. {% /admonition %}
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.conversation_id |
integer | Required | id | |
query |
object | Optional | additionalProperties: false |
|
query.retain_metrics |
boolean | Optional | If true (default), deletes the conversation while retaining reporting data. If false, deletes the conversation and all associated reporting data. Setting to false requires the delete_conversations_and_metrics OAuth scope. |
Full JSON Schema
Example input
{
"path": {
"conversation_id": 1
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Search conversations — intercom.searchconversations
You can search for multiple conversations by the value of their attributes in order to fetch exactly which ones you want.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
query |
object | Optional | additionalProperties: false |
|
query.include_monitors |
boolean | Optional | If set to true, the response will include a monitor_evaluations array on each conversation with the latest QA monitor evaluation for each monitor that has evaluated it. |
default: false |
query.include_scorecards |
boolean | Optional | If set to true, the response will include a scorecards array on each conversation with any QA scorecard results. |
default: false |
body |
— | Optional | $ref: "#/definitions/search_request" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Reply to a conversation — intercom.replyconversation
You can reply to a conversation with a message from an admin or on behalf of a contact, or with a note for admins.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.conversation_id |
string | Required | The Intercom provisioned identifier for the conversation, or the string last to use the most recent conversation of a contact. With last, also send the contact's intercom_user_id, user_id or email in the request body, whatever type of request you send. A contact that can't be found returns a 404 error, and a contact with no conversations returns a 422 error. |
|
body |
— | Optional | $ref: "#/definitions/reply_conversation_request" |
Full JSON Schema
Example input
{
"path": {
"conversation_id": "123 or \"last\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Manage a conversation — intercom.manageconversation
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 an admin and/or team.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.conversation_id |
string | Required | The identifier for the conversation as given by Intercom, or the string last to use the most recent conversation of a contact. With last, also send the contact's intercom_user_id, user_id or email in the request body, whatever type of request you send. A contact that can't be found returns a 404 error, and a contact with no conversations returns a 422 error. |
|
body |
— | Optional | ||
body |
— | Optional | oneOf[1]; $ref: "#/definitions/close_conversation_request" |
|
body |
— | Optional | oneOf[2]; $ref: "#/definitions/snooze_conversation_request" |
|
body |
— | Optional | oneOf[3]; $ref: "#/definitions/open_conversation_request" |
|
body |
— | Optional | oneOf[4]; $ref: "#/definitions/assign_conversation_request" |
Full JSON Schema
Example input
{
"path": {
"conversation_id": "123"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Attach a contact to a conversation — intercom.attachcontacttoconversation
You can add participants who are contacts to a conversation, on behalf of either another contact or an admin.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.conversation_id |
string | Required | The identifier for the conversation as given by Intercom. | |
body |
— | Optional | $ref: "#/definitions/attach_contact_to_conversation_request" |
Full JSON Schema
Example input
{
"path": {
"conversation_id": "123"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Detach a contact from a group conversation — intercom.detachcontactfromconversation
You can remove participants who are contacts from a group conversation, on behalf of an admin.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.conversation_id |
string | Required | The identifier for the conversation as given by Intercom. | |
path.contact_id |
string | Required | The identifier for the contact as given by Intercom. | |
body |
— | Optional | $ref: "#/definitions/detach_contact_from_conversation_request" |
Full JSON Schema
Example input
{
"path": {
"conversation_id": "123",
"contact_id": "123"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List handling events — intercom.listhandlingevents
List all pause/resume events for a conversation. These events track when teammates paused or resumed handling a conversation.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The identifier for the conversation as given by Intercom. |
Full JSON Schema
Example input
{
"path": {
"id": "123"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List HITL events — intercom.listhitlevents
List the human-in-the-loop (HITL) events for a conversation. When Fin is unsure of an answer it can consult a teammate before replying, proposing a draft that the teammate approves, steers with free-text feedback, or takes over. Each consultation is returned as a series of events, oldest first, across every consultation on the conversation.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The identifier for the conversation as given by Intercom. |
Full JSON Schema
Example input
{
"path": {
"id": "123"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List side conversations — intercom.listsideconversations
List side conversations for a given conversation. Side conversations are internal threads created by teammates from within a conversation.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The identifier for the conversation as given by Intercom. | |
query |
object | Optional | additionalProperties: false |
|
query.page |
integer | Optional | The page number of results to return (starting from 1). | default: 1 |
query.per_page |
integer | Optional | The number of side conversations to return per page (max 50). | default: 25; maximum: 50 |
Full JSON Schema
Example input
{
"path": {
"id": "123"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Redact a conversation part — intercom.redactconversation
You can redact a conversation part or the source message of a conversation (as seen in the source object).
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
body |
— | Optional | $ref: "#/definitions/redact_conversation_request" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Merge a conversation — intercom.mergeconversation
Merge a secondary (source) conversation into a primary (target) conversation. The secondary conversation is closed and linked to the primary, which becomes the surviving thread. Returns the primary conversation on success.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The identifier for the secondary (source) conversation to merge away. | |
body |
— | Optional | $ref: "#/definitions/merge_conversations_request" |
Full JSON Schema
Example input
{
"path": {
"id": "123"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Convert a conversation to a ticket — intercom.convertconversationtoticket
You can convert a conversation to a ticket.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.conversation_id |
integer | Required | The id of the conversation to target | |
body |
— | Optional | $ref: "#/definitions/convert_conversation_to_ticket_request" |
Full JSON Schema
Example input
{
"path": {
"conversation_id": 123
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List all deleted conversation IDs — intercom.listdeletedconversationids
List all deleted conversation IDs.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
query |
object | Optional | additionalProperties: false |
|
query.page |
integer | Optional | The page of results to fetch. Defaults to first page | |
query.per_page |
integer | Optional | How many results per page | default: 20; maximum: 60 |
query.order |
string | Optional | asc or desc. Returns the conversation IDs in ascending or descending order. Defaults to desc |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
List all conversation attributes — intercom.listconversationattributes
You can fetch a list of all conversation attributes for your workspace.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
query |
object | Optional | additionalProperties: false |
|
query.include_archived |
boolean | Optional | Include archived attributes in the list. Default false. |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a conversation attribute — intercom.createconversationattribute
Create a new conversation attribute.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
body |
— | Required | $ref: "#/definitions/create_conversation_attribute_request" |
Full JSON Schema
Example input
{
"body": {
"name": "api_test_attr",
"data_type": "string"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get a conversation attribute — intercom.getconversationattribute
Retrieve a single conversation attribute by ID.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.id |
integer | Required | The conversation attribute id |
Full JSON Schema
Example input
{
"path": {
"id": 3
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update a conversation attribute — intercom.updateconversationattribute
Update an existing conversation attribute.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.id |
integer | Required | The conversation attribute id | |
body |
— | Required | $ref: "#/definitions/update_conversation_attribute_request" |
Full JSON Schema
Example input
{
"path": {
"id": 8
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete (archive) a conversation attribute — intercom.deleteconversationattribute
Archive a conversation attribute (soft delete). The attribute is marked as archived but not permanently deleted.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.id |
integer | Required | The conversation attribute id |
Full JSON Schema
Example input
{
"path": {
"id": 8
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Add an option to a list conversation attribute — intercom.createconversationattributeoption
Add a new option to a list-type conversation attribute. Returns the full attribute with the updated options array.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.id |
integer | Required | The conversation attribute id | |
body |
— | Required | $ref: "#/definitions/create_conversation_attribute_option_request" |
Full JSON Schema
Example input
{
"path": {
"id": 2
},
"body": {
"label": "High"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update an option on a list conversation attribute — intercom.updateconversationattributeoption
Update the label of a single option on a list-type conversation attribute. Returns the full attribute with the updated options array.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.id |
integer | Required | The conversation attribute id | |
path.option_id |
string | Required | The UUID of the list option to update (from the id field in the options array) |
|
body |
— | Required | $ref: "#/definitions/update_conversation_attribute_option_request" |
Full JSON Schema
Example input
{
"path": {
"id": 2,
"option_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
},
"body": {
"label": "Renamed"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Archive an option on a list conversation attribute — intercom.deleteconversationattributeoption
Archive a single option on a list-type conversation attribute (soft delete). The option remains in the response with archived: true. Returns the full attribute with the updated options array.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.id |
integer | Required | The conversation attribute id | |
path.option_id |
string | Required | The UUID of the list option to archive (from the id field in the options array) |
Full JSON Schema
Example input
{
"path": {
"id": 2,
"option_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create or Update a Custom Object Instance — intercom.createcustomobjectinstances
Create or update a custom object instance
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.custom_object_type_identifier |
string | Required | The unique identifier of the custom object type that defines the structure of the custom object instance. | |
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
body |
— | Optional | $ref: "#/definitions/create_or_update_custom_object_instance_request" |
Full JSON Schema
Example input
{
"path": {
"custom_object_type_identifier": "Order"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Custom Object Instances — intercom.listcustomobjectinstances
List instances of a custom object type. Three modes are supported: - No filter — returns all instances for the type. - references_contact_id — returns instances associated with the given contact. - references_conversation_id — returns instances associated with the given conversation.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.custom_object_type_identifier |
string | Required | The unique identifier of the custom object type that defines the structure of the custom object instance. | |
query |
object | Optional | additionalProperties: false |
|
query.references_contact_id |
string | Optional | Return instances associated with the given contact ID. | |
query.references_conversation_id |
string | Optional | Return instances associated with the given conversation ID. | |
query.external_id |
string | Optional | Return the single instance with this external ID. When provided, the response is a single object rather than a list. | |
query.page |
integer | Optional | Page number of results to fetch. | |
query.per_page |
integer | Optional | Number of results per page. Maximum 150. | maximum: 150 |
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
Full JSON Schema
Example input
{
"path": {
"custom_object_type_identifier": "Order"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Custom Object Instance by ID — intercom.getcustomobjectinstancesbyid
Fetch a Custom Object Instance by id.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.custom_object_type_identifier |
string | Required | The unique identifier of the custom object type that defines the structure of the custom object instance. | |
path.custom_object_instance_id |
string | Required | The Intercom defined id of the custom object instance. An external id here is not looked up; to find an instance by its external id, call GET /custom_object_instances/{custom_object_type_identifier}?external_id=. |
|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
Full JSON Schema
Example input
{
"path": {
"custom_object_type_identifier": "Order",
"custom_object_instance_id": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete a Custom Object Instance by ID — intercom.deletecustomobjectinstancesbyid
Delete a single Custom Object instance using the Intercom defined id.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.custom_object_type_identifier |
string | Required | The unique identifier of the custom object type that defines the structure of the custom object instance. | |
path.custom_object_instance_id |
string | Required | The Intercom defined id of the custom object instance | |
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
Full JSON Schema
Example input
{
"path": {
"custom_object_type_identifier": "Order",
"custom_object_instance_id": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List all data attributes — intercom.lisdataattributes
You can fetch a list of all data attributes belonging to a workspace for contacts or companies.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
query |
object | Optional | additionalProperties: false |
|
query.model |
string | Optional | Specify the data attribute model to return. For conversation attributes, use GET /conversations/attributes instead. | enum: ["contact","company"] |
query.include_archived |
boolean | Optional | Include archived attributes in the list. By default we return only non archived data attributes. |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a data attribute — intercom.createdataattribute
You can create a data attributes for a contact or a company.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
body |
— | Optional | $ref: "#/definitions/create_data_attribute_request" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update a data attribute — intercom.updatedataattribute
You can update a data attribute.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.data_attribute_id |
integer | Required | The data attribute id | |
body |
— | Optional | $ref: "#/definitions/update_data_attribute_request" |
Full JSON Schema
Example input
{
"path": {
"data_attribute_id": 1
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List all data connectors — intercom.listdataconnectors
Returns a paginated list of all data connectors for the workspace, ordered by most recently updated first. Data connectors allow workflows and AI agents to make HTTP requests to external APIs.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
query |
object | Optional | additionalProperties: false |
|
query.per_page |
integer | Optional | The number of results to return per page. Defaults to 20, minimum 1, maximum 50. | default: 20; minimum: 1; maximum: 50 |
query.starting_after |
string | Optional | The cursor value from pages.next.starting_after in a previous response. Used to paginate through results. |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a data connector — intercom.createdataconnector
Create a new data connector. The connector is created in draft state. Configure its URL, headers, data inputs, and other settings, then set it to live when ready.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
body |
— | Optional | $ref: "#/definitions/create_data_connector_request" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a data connector — intercom.retrievedataconnector
You can retrieve the full detail of a single data connector by its ID.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The unique identifier of the data connector. | |
query |
object | Optional | additionalProperties: false |
|
query.state_version |
string | Optional | Which version of the data connector to return. Defaults to live. | enum: ["draft","live"]; default: "live" |
Full JSON Schema
Example input
{
"path": {
"id": "12345"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete a data connector — intercom.deletedataconnector
Delete an existing data connector. The connector must be in draft state and must not be in use by any workflows or AI agents.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The unique identifier of the data connector |
Full JSON Schema
Example input
{
"path": {
"id": "12345"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update a data connector — intercom.updatedataconnector
Update an existing data connector. Only provided fields are changed. Set state to live or draft to change the connector's state.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The unique identifier of the data connector. | |
body |
— | Optional | $ref: "#/definitions/update_data_connector_request" |
Full JSON Schema
Example input
{
"path": {
"id": "12345"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List execution results for a data connector — intercom.listdataconnectorexecutionresults
Retrieve paginated execution logs for a specific data connector. Results from the last hour are returned by default. Use start_ts and end_ts to customize the time range.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.data_connector_id |
string | Required | The unique identifier for the data connector. | |
query |
object | Optional | additionalProperties: false |
|
query.per_page |
integer | Optional | The number of results per page (1-30, default 10). | default: 10; minimum: 1; maximum: 30 |
query.starting_after |
string | Optional | Cursor for pagination. Use the value from pages.next.starting_after in a previous response. |
|
query.success |
string | Optional | Filter by success status. Use true, false, or omit for all. |
enum: ["true","false"] |
query.error_type |
string | Optional | Filter by error type. | enum: ["request_configuration_error","faraday_error","3rd_party_error","response_mapping_error","token_refresh_error","fin_action_response_formatting_error","fin_action_identity_verification_error","email_verification_error","non_fin_standalone_action_identity_verification_error","request_validation_error","client_side_action_error","code_block_transformation_error","otp_preview_not_supported_error"] |
query.start_ts |
integer | Optional | Unix timestamp for start of time range (default 1 hour ago). | |
query.end_ts |
integer | Optional | Unix timestamp for end of time range (default now). | |
query.include_bodies |
string | Optional | Include request/response bodies in the response (default false). | enum: ["true","false"] |
Full JSON Schema
Example input
{
"path": {
"data_connector_id": "12345"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve an execution result — intercom.showdataconnectorexecutionresult
Retrieve details for a specific data connector execution result. Includes the request/response bodies and sanitised request URL when they are available.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.data_connector_id |
string | Required | The unique identifier for the data connector. | |
path.id |
string | Required | The unique identifier for the execution result. |
Full JSON Schema
Example input
{
"path": {
"data_connector_id": "12345",
"id": "99001"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List versions of a data connector — intercom.listdataconnectorversions
Retrieve the version history of a data connector, newest first. Each entry is a point-in-time snapshot of the connector's configuration, with the status it has today and an optional note.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The unique identifier for the data connector. | |
query |
object | Optional | additionalProperties: false |
|
query.per_page |
integer | Optional | The number of results per page (1-50, default 20). Values outside this range are clamped, so values below 1 are treated as 1. A non-integer value falls back to the default of 20. | default: 20; minimum: 1; maximum: 50 |
query.starting_after |
string | Optional | Cursor for pagination. Use the value from pages.next.starting_after in a previous response. |
Full JSON Schema
Example input
{
"path": {
"id": "12345"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a version of a data connector — intercom.retrievedataconnectorversion
Retrieve a single version of a data connector, including the connector configuration as it was at that version.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The unique identifier for the data connector. | |
path.version_id |
integer | Required | The entity_version_id of the version, as returned by List versions of a data connector. |
Full JSON Schema
Example input
{
"path": {
"id": "12345",
"version_id": 9821
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update the note on a data connector version — intercom.updatedataconnectorversion
Update the note on a data connector version. The note is the only field that can be changed. This does not publish the version or roll the connector back to it.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The unique identifier for the data connector. | |
path.version_id |
integer | Required | The entity_version_id of the version, as returned by List versions of a data connector. |
|
body |
— | Required | $ref: "#/definitions/update_data_connector_version_request" |
Full JSON Schema
Example input
{
"path": {
"id": "12345",
"version_id": 9821
},
"body": {
"note": "Switched to the v2 orders endpoint"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Submit a data event — intercom.createdataevent
You will need an Access Token that has write permissions to send Events. Once you have a key you can submit events via POST to the Events resource, which is located at https://api.intercom.io/events, or you can send events using one of the client libraries. When working with the HTTP API directly a client should send the event with a Content-Type of application/json.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
body |
— | Optional | $ref: "#/definitions/create_data_event_request" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
List all data events — intercom.lisdataevents
> 🚧 > > Please note that you can only 'list' events that are less than 90 days old. Event counts and summaries will still include your events older than 90 days but you cannot 'list' these events individually if they are older than 90 days
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
query |
object | Required | additionalProperties: false |
|
query.filter |
object | Required | ||
query.filter |
object | Required | user_id query parameter | oneOf[1]; additionalProperties: false |
query.filter.user_id |
string | Required | oneOf[1] |
|
query.filter |
object | Required | intercom_user_id query parameter | oneOf[2]; additionalProperties: false |
query.filter.intercom_user_id |
string | Required | oneOf[2] |
|
query.filter |
object | Required | email query parameter | oneOf[3]; additionalProperties: false |
query.filter.email |
string | Required | oneOf[3] |
|
query.filter |
object | Required | anonymous_id query parameter | oneOf[4]; additionalProperties: false |
query.filter.anonymous_id |
string | Required | oneOf[4] |
|
query.type |
string | Required | The value must be user or lead. |
enum: ["user","lead"] |
query.per_page |
integer | Optional | The number of events to return per page. | |
query.since |
integer | Optional | Only return events created after this time, as a Unix timestamp in milliseconds. Take the value from the since link in the pages object of a previous response. |
|
query.before |
integer | Optional | Only return events created before this time, as a Unix timestamp in milliseconds. Take the value from the next link in the pages object of a previous response. |
|
query.summary |
boolean | Optional | Set to true (or 1) to return an event summary (event.summary) instead of the list of events. Omit for the paginated event list (event.list). |
Full JSON Schema
Example input
{
"query": {
"filter": {
"user_id": "example"
},
"type": "user"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create event summaries — intercom.dataeventsummaries
Create event summaries for a user. Event summaries are used to track the number of times an event has occurred, the first time it occurred and the last time it occurred.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
body |
— | Optional | $ref: "#/definitions/create_data_event_summaries_request" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create content data export — intercom.createdataexport
To create your export job, you need to send a POST request to the export endpoint https://api.intercom.io/export/content/data.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
body |
— | Optional | $ref: "#/definitions/create_data_exports_request" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Show content data export — intercom.getdataexport
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 response when you first created the export job. More on it can be seen in the Export Job Model.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.job_identifier |
string | Required | job_identifier |
Full JSON Schema
Example input
{
"path": {
"job_identifier": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Cancel content data export — intercom.canceldataexport
You can cancel your job. A job that has already reached a terminal state is returned unchanged.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.job_identifier |
string | Required | job_identifier |
Full JSON Schema
Example input
{
"path": {
"job_identifier": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Download content data export — intercom.downloaddataexport
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: https://api.intercom.io/download/content/data/xyz1234.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.job_identifier |
string | Required | job_identifier |
Full JSON Schema
Example input
{
"path": {
"job_identifier": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve job status — intercom.jobsstatus
Retrieve the status of job execution.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.job_id |
string | Required | The unique identifier for the job which is given by Intercom |
Full JSON Schema
Example input
{
"path": {
"job_id": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a message — intercom.createmessage
You can create a message that has been initiated by an admin. The conversation can be either an in-app message, an email or whatsapp.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
body |
— | Optional | $ref: "#/definitions/create_message_request" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve WhatsApp message delivery status — intercom.retrievewhatsappmessagestatus
Retrieves the delivery status of a specific WhatsApp message by its message ID.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
query |
object | Required | additionalProperties: false |
|
query.message_id |
string | Required | The WhatsApp message ID to check status for |
Full JSON Schema
Example input
{
"query": {
"message_id": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get statuses of all messages sent based on the specified ruleset_id — intercom.getwhatsappmessagestatus
Retrieves statuses of messages sent from the Outbound module. Currently, this API only supports WhatsApp messages.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
query |
object | Required | additionalProperties: false |
|
query.ruleset_id |
string | Required | The unique identifier for the set of messages to check status for | |
query.per_page |
integer | Optional | Number of results per page (default 50, max 100) | default: 50; maximum: 100 |
query.starting_after |
string | Optional | Cursor for pagination, used to fetch the next page of results |
Full JSON Schema
Example input
{
"query": {
"ruleset_id": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List all news items — intercom.listnewsitems
You can fetch a list of all news items
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
query |
object | Optional | additionalProperties: false |
|
query.page |
integer | Optional | The page of results to fetch. | default: 1 |
query.per_page |
integer | Optional | The number of news items to return per page. Values above 20 are reduced to 20. | default: 10; maximum: 20 |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a news item — intercom.createnewsitem
You can create a news item
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
body |
— | Optional | $ref: "#/definitions/news_item_request" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a news item — intercom.retrievenewsitem
You can fetch the details of a single news item.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.news_item_id |
integer | Required | The unique identifier for the news item which is given by Intercom. |
Full JSON Schema
Example input
{
"path": {
"news_item_id": 123
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update a news item — intercom.updatenewsitem
You can update a news item.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.news_item_id |
integer | Required | The unique identifier for the news item which is given by Intercom. | |
body |
— | Optional | $ref: "#/definitions/update_news_item_request" |
Full JSON Schema
Example input
{
"path": {
"news_item_id": 123
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete a news item — intercom.deletenewsitem
You can delete a single news item.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.news_item_id |
integer | Required | The unique identifier for the news item which is given by Intercom. |
Full JSON Schema
Example input
{
"path": {
"news_item_id": 123
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List all live newsfeed items — intercom.listlivenewsfeeditems
You can fetch a list of all news items that are live on a given newsfeed
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.newsfeed_id |
string | Required | The unique identifier for the news feed item which is given by Intercom. | |
query |
object | Optional | additionalProperties: false |
|
query.page |
integer | Optional | The page of results to fetch. | default: 1 |
query.per_page |
integer | Optional | The number of news items to return per page. Values above 20 are reduced to 20. | default: 20; maximum: 20 |
Full JSON Schema
Example input
{
"path": {
"newsfeed_id": "123"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List all newsfeeds — intercom.listnewsfeeds
You can fetch a list of all newsfeeds
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
query |
object | Optional | additionalProperties: false |
|
query.page |
integer | Optional | The page of results to fetch. | default: 1 |
query.per_page |
integer | Optional | The number of newsfeeds to return per page. Values above 20 are reduced to 20. | default: 10; maximum: 20 |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a newsfeed — intercom.retrievenewsfeed
You can fetch the details of a single newsfeed
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.newsfeed_id |
string | Required | The unique identifier for the news feed item which is given by Intercom. |
Full JSON Schema
Example input
{
"path": {
"newsfeed_id": "123"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a note — intercom.retrievenote
You can fetch the details of a single note.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.note_id |
string | Required | The unique identifier of a given note |
Full JSON Schema
Example input
{
"path": {
"note_id": "34"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete a note — intercom.deletenote
You can delete a single contact or company note. Notes of other kinds cannot be deleted through the API.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.note_id |
string | Required | The unique identifier of a given note |
Full JSON Schema
Example input
{
"path": {
"note_id": "34"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List all segments — intercom.listsegments
You can fetch a list of all segments.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
query |
object | Optional | additionalProperties: false |
|
query.include_count |
boolean | Optional | Includes the count of contacts that belong to each segment. The counts are added whenever this parameter has a value in the query string, even false or an empty one, so omit it entirely to leave them out. A bare include_count with no = adds no counts. With type=company, a company segment gets no count unless a contact segment has the same name, and then it shows that contact segment's count. |
|
query.type |
string | Optional | Pass company to list company segments. Any other value, or no value, lists contact segments. |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a segment — intercom.retrievesegment
You can fetch the details of a single segment.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.segment_id |
string | Required | The unique identified of a given segment. | |
query |
object | Optional | additionalProperties: false |
|
query.include_count |
boolean | Optional | Includes the count of contacts that belong to the segment. The count is added whenever this parameter has a value in the query string, even false or an empty one, so omit it entirely to leave it out. A bare include_count with no = adds no count. |
Full JSON Schema
Example input
{
"path": {
"segment_id": "123"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List subscription types — intercom.listsubscriptiontypes
You can list all subscription types. A list of subscription type objects will be returned.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a subscription type — intercom.getsubscriptiontype
You can fetch the details of a single subscription type by making a GET request to https://api.intercom.io/subscription_types/<id>.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The unique identifier for the subscription type. |
Full JSON Schema
Example input
{
"path": {
"id": "123"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a phone Switch — intercom.createphoneswitch
You can use the API to deflect phone calls to the Intercom Messenger. Calling this endpoint will send an SMS with a link to the Messenger to the phone number specified.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
body |
— | Optional | $ref: "#/definitions/create_phone_switch_request" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
List all calls — intercom.listcalls
Retrieve a paginated list of calls.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
query |
object | Optional | additionalProperties: false |
|
query.page |
integer | Optional | The page of results to fetch. Defaults to first page | |
query.per_page |
integer | Optional | How many results to display per page. Defaults to 25. Must be between 1 and 25. A value outside that range returns a 400 error. | minimum: 1; maximum: 25 |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get a call — intercom.showcall
Retrieve a single call by id.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.call_id |
string | Required | The id of the call to retrieve |
Full JSON Schema
Example input
{
"path": {
"call_id": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get call transcript by call id — intercom.showcalltranscript
Returns the transcript for the specified call as a JSON array of turns.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The id of the call |
Full JSON Schema
Example input
{
"path": {
"id": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List calls with transcripts — intercom.listcallswithtranscripts
Retrieve calls by a list of conversation ids and include transcripts when available. A maximum of 20 conversation_ids can be provided. If none are provided or more than 20 are provided, a 400 error is returned.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
body |
object | Required | ||
body.conversation_ids |
array | Required | A list of conversation ids to fetch calls for. Maximum 20. | minItems: 1; maxItems: 20 |
body.conversation_ids[] |
string | Optional |
Full JSON Schema
Example input
{
"body": {
"conversation_ids": [
"64619700005694",
"64619700005695"
]
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create or update a tag, Tag or untag companies, Tag contacts — intercom.createtag
You can use this endpoint to perform the following operations:
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
body |
— | Optional | ||
body |
— | Optional | anyOf[1]; $ref: "#/definitions/create_or_update_tag_request" |
|
body |
— | Optional | anyOf[2]; $ref: "#/definitions/tag_company_request" |
|
body |
— | Optional | anyOf[3]; $ref: "#/definitions/untag_company_request" |
|
body |
— | Optional | anyOf[4]; $ref: "#/definitions/tag_multiple_users_request" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Find a specific tag — intercom.findtag
You can fetch the details of tags that are on the workspace by their id. This will return a tag object.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.tag_id |
string | Required | The unique identifier of a given tag |
Full JSON Schema
Example input
{
"path": {
"tag_id": "123"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete tag — intercom.deletetag
You can delete the details of tags that are on the workspace by passing in the id.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.tag_id |
string | Required | The unique identifier of a given tag |
Full JSON Schema
Example input
{
"path": {
"tag_id": "123"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List all teams — intercom.listteams
This will return a list of team objects for the App.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a team — intercom.retrieveteam
You can fetch the details of a single team, containing an array of admins that belong to this team.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.team_id |
string | Required | The unique identifier of a given team. |
Full JSON Schema
Example input
{
"path": {
"team_id": "123"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve team metrics — intercom.getteammetrics
Returns real-time activity metrics for admins in the specified team. For each admin, the response includes counts of open, idle, and snoozed conversations.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.team_id |
string | Required | The unique identifier of the team to retrieve metrics for. Use GET /teams to list available team IDs. |
|
query |
object | Optional | additionalProperties: false |
|
query.idle_threshold |
integer | Optional | The number of seconds after which an open conversation is considered idle. Clamped to the range 1–86400. Defaults to 1800 (30 minutes). | default: 1800 |
Full JSON Schema
Example input
{
"path": {
"team_id": "42"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List all ticket states — intercom.listticketstates
You can get a list of all ticket states for a workspace. The list includes archived ticket states; check archived on each one.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a new attribute for a ticket type — intercom.createtickettypeattribute
You can create a new attribute for a ticket type.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.ticket_type_id |
string | Required | The unique identifier for the ticket type which is given by Intercom. | |
body |
— | Optional | $ref: "#/definitions/create_ticket_type_attribute_request" |
Full JSON Schema
Example input
{
"path": {
"ticket_type_id": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update an existing attribute for a ticket type — intercom.updatetickettypeattribute
You can update an existing attribute for a ticket type.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.ticket_type_id |
string | Required | The unique identifier for the ticket type which is given by Intercom. | |
path.attribute_id |
string | Required | The unique identifier for the ticket type attribute which is given by Intercom. | |
body |
— | Optional | $ref: "#/definitions/update_ticket_type_attribute_request" |
Full JSON Schema
Example input
{
"path": {
"ticket_type_id": "example",
"attribute_id": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List all ticket types — intercom.listtickettypes
You can get a list of all ticket types for a workspace. The list includes archived ticket types and ticket types that Intercom creates itself.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a ticket type — intercom.createtickettype
You can create a new ticket type. > 📘 Creating ticket types. > > Every ticket type will be created with two default attributes: _default_title_ and _default_description_. > For the icon propery, use an emoji from Twemoji Cheatsheet
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
body |
— | Optional | $ref: "#/definitions/create_ticket_type_request" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a ticket type — intercom.gettickettype
You can fetch the details of a single ticket type. Archived ticket types are returned as well.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.ticket_type_id |
string | Required | The unique identifier for the ticket type which is given by Intercom. |
Full JSON Schema
Example input
{
"path": {
"ticket_type_id": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update a ticket type — intercom.updatetickettype
You can update a ticket type.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.ticket_type_id |
string | Required | The unique identifier for the ticket type which is given by Intercom. | |
body |
— | Optional | $ref: "#/definitions/update_ticket_type_request" |
Full JSON Schema
Example input
{
"path": {
"ticket_type_id": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Reply to a ticket — intercom.replyticket
You can reply to a ticket with a message from an admin or on behalf of a contact, or with a note for admins.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.ticket_id |
string | Required | The id of the ticket to target. {% admonition type="info" name="Not the Inbox ticket ID" %} This is the internal id field from the API response, not the ticket_id displayed in the Intercom Inbox (e.g., #12345). Use the id value from the ticket object returned by the API. {% /admonition %} |
|
body |
object | Optional | ||
body.skip_notifications |
boolean | Optional | Option to disable notifications when replying to a Ticket. | |
body |
— | Optional | oneOf[1]; $ref: "#/definitions/contact_reply_ticket_request" |
|
body |
— | Optional | oneOf[2]; $ref: "#/definitions/admin_reply_ticket_request" |
Full JSON Schema
Example input
{
"path": {
"ticket_id": "123"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Add tag to a ticket — intercom.attachtagtoticket
You can tag a specific ticket. This will return a tag object for the tag that was added to the ticket.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.ticket_id |
string | Required | ticket_id | |
body |
object | Optional | ||
body.id |
string | Required | The unique identifier for the tag which is given by Intercom | |
body.admin_id |
string | Required | The unique identifier for the admin which is given by Intercom. |
Full JSON Schema
Example input
{
"path": {
"ticket_id": "64619700005694"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Remove tag from a ticket — intercom.detachtagfromticket
You can remove tag from a specific ticket. This will return a tag object for the tag that was removed from the ticket.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.ticket_id |
string | Required | ticket_id | |
path.tag_id |
string | Required | The unique identifier for the tag which is given by Intercom | |
body |
object | Optional | ||
body.admin_id |
string | Required | The unique identifier for the admin which is given by Intercom. |
Full JSON Schema
Example input
{
"path": {
"ticket_id": "64619700005694",
"tag_id": "7522907"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Link a conversation to a ticket — intercom.linkconversationtoticket
Link a conversation to an existing tracker ticket. The conversation can be a regular conversation or one that has been converted into a customer ticket.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.ticket_id |
string | Required | The unique identifier for the tracker ticket which is given by Intercom. | |
body |
object | Optional | ||
body.conversation_id |
string | Required | The unique identifier (given by Intercom) for the conversation or customer ticket to link to the tracker ticket. |
Full JSON Schema
Example input
{
"path": {
"ticket_id": "64619700005694"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Unlink a conversation from a ticket — intercom.unlinkconversationfromticket
Unlink a conversation (or converted customer ticket) from a tracker ticket it is currently linked to. The ticket in the path must be a tracker ticket. This returns the conversation that was unlinked.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.ticket_id |
string | Required | The unique identifier for the tracker ticket which is given by Intercom. | |
path.id |
string | Required | The unique identifier (given by Intercom) for the linked conversation or customer ticket to unlink. |
Full JSON Schema
Example input
{
"path": {
"ticket_id": "64619700005694",
"id": "204"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a ticket — intercom.createticket
You can create a new ticket.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
body |
object | Optional | ||
body.skip_notifications |
boolean | Optional | Option to disable notifications when a Ticket is created. | |
body |
— | Optional | allOf[1]; $ref: "#/definitions/create_ticket_request" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Enqueue create ticket — intercom.enqueuecreateticket
Enqueues ticket creation for asynchronous processing, returning if the job was enqueued successfully to be processed. We attempt to perform a best-effort validation on inputs before tasks are enqueued. If the given parameters are incorrect, we won't enqueue the job.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
body |
object | Optional | ||
body.skip_notifications |
boolean | Optional | Option to disable notifications when a Ticket is created. | |
body |
— | Optional | allOf[1]; $ref: "#/definitions/create_ticket_request" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update a ticket — intercom.updateticket
You can update a ticket.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.ticket_id |
string | Required | The unique identifier for the ticket which is given by Intercom. {% admonition type="info" name="Not the Inbox ticket ID" %} This is the internal id field from the API response, not the ticket_id displayed in the Intercom Inbox (e.g., #12345). Use the id value from the ticket object returned by the API. {% /admonition %} |
|
body |
object | Optional | ||
body.skip_notifications |
boolean | Optional | Option to disable notifications when a Ticket is updated. | |
body |
— | Optional | allOf[1]; $ref: "#/definitions/update_ticket_request" |
Full JSON Schema
Example input
{
"path": {
"ticket_id": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a ticket — intercom.getticket
You can fetch the details of a single ticket.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.ticket_id |
string | Required | The unique identifier for the ticket which is given by Intercom. {% admonition type="info" name="Not the Inbox ticket ID" %} This is the internal id field from the API response, not the ticket_id displayed in the Intercom Inbox (e.g., #12345). Use the id value from the ticket object returned by the API. {% /admonition %} |
Full JSON Schema
Example input
{
"path": {
"ticket_id": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete a ticket — intercom.deleteticket
{% admonition type="warning" name="Irreversible operation" %} Deleting a ticket is permanent and cannot be reversed. {% /admonition %}
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.ticket_id |
string | Required | The unique identifier for the ticket which is given by Intercom. {% admonition type="info" name="Not the Inbox ticket ID" %} This is the internal id field from the API response, not the ticket_id displayed in the Intercom Inbox (e.g., #12345). Use the id value from the ticket object returned by the API. {% /admonition %} |
Full JSON Schema
Example input
{
"path": {
"ticket_id": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Change ticket type — intercom.changetickettype
You can change the type of a ticket. The new ticket type must be in the same category as the current type. Attributes matching by name and type are automatically transferred from the old type; values provided in ticket_attributes override transferred values.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.ticket_id |
string | Required | The unique identifier for the ticket which is given by Intercom. | |
body |
— | Optional | $ref: "#/definitions/change_ticket_type_request" |
Full JSON Schema
Example input
{
"path": {
"ticket_id": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Search tickets — intercom.searchtickets
You can search for multiple tickets by the value of their attributes in order to fetch exactly which ones you want.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
body |
— | Optional | $ref: "#/definitions/search_request" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update a visitor — intercom.updatevisitor
Sending a PUT request to /visitors will result in an update of an existing Visitor.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
body |
— | Optional | $ref: "#/definitions/update_visitor_request" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a visitor with User ID — intercom.retrievevisitorwithuserid
You can fetch the details of a single visitor.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
query |
object | Required | additionalProperties: false |
|
query.user_id |
string | Required | The user_id of the Visitor you want to retrieve. |
Full JSON Schema
Example input
{
"query": {
"user_id": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Convert a visitor — intercom.convertvisitor
You can merge a Visitor to a Contact of role type lead or user.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
body |
— | Optional | $ref: "#/definitions/convert_visitor_request" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
List all brands — intercom.listbrands
Retrieves all brands for the workspace, including the default brand. The default brand id always matches the workspace id.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a brand — intercom.retrievebrand
Fetches a specific brand by its unique identifier
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The unique identifier of the brand |
Full JSON Schema
Example input
{
"path": {
"id": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List all email settings — intercom.listemails
Lists all sender email address settings for the workspace
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve an email setting — intercom.retrieveemail
Fetches a specific email setting by its unique identifier
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The unique identifier of the email setting |
Full JSON Schema
Example input
{
"path": {
"id": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Register a Fin Voice call — intercom.registerfinvoicecall
Register a Fin Voice call with Intercom. This endpoint creates an external reference that links an external call identifier to an Intercom call and conversation.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
body |
— | Optional | $ref: "#/definitions/register_fin_voice_call_request" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Collect Fin Voice call by ID — intercom.collectfinvoicecallbyid
Retrieve information about a Fin Voice call using the external reference ID.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.id |
integer | Required | The external reference ID |
Full JSON Schema
Example input
{
"path": {
"id": 1
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Collect Fin Voice call by external ID — intercom.collectfinvoicecallbyexternalid
Retrieve information about a Fin Voice call using the external call identifier.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.external_id |
string | Required | The external call identifier from the call provider |
Full JSON Schema
Example input
{
"path": {
"external_id": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Collect Fin Voice call by phone number — intercom.collectfinvoicecallbyphonenumber
Retrieve information about a Fin Voice call using the phone number.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.phone_number |
string | Required | Phone number in E.164 format |
Full JSON Schema
Example input
{
"path": {
"phone_number": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Collect Fin Voice calls by conversation ID — intercom.collectfinvoicecallsbyconversationid
Retrieve information about Fin Voice calls associated with a conversation.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.conversation_id |
string | Required | The Intercom conversation identifier |
Full JSON Schema
Example input
{
"path": {
"conversation_id": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Export a workflow — intercom.exportworkflow
Export a workflow configuration by its ID. This endpoint returns the complete workflow definition including its steps, targeting rules, and attributes.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Intercom-Version |
— | Optional | enum: ["2.17"]; $ref: "#/definitions/intercom_version" |
|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ruleset ID of the workflow. This is the number at the end of the workflow's URL in Intercom, https://app.intercom.com/a/apps/<app_id>/automation/workflows/<id>. It is not the workflow.id returned in the response, so don't pass that value back here. |
Full JSON Schema
Example input
{
"path": {
"id": "12345"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Errors
Check the key's expiry, revocation, workspace and allowed operations.
Reuse the same idempotency key only for the same request.
The connection or provider limit has been reached. Check the receipt before retrying.
Test the connection
Open the integration's commands below to inspect parameters and examples. Start with a read command for an account or resource you can access. Refresh your client's tool list, use the returned tool name, and check the execution result and usage. Provider charges and permissions still apply. Never test a write against production data without reviewing it.