--- title: "Intercom" description: "Read and manage permitted Intercom contacts, companies, conversations, articles, tickets and workspace resources using the official REST API pinned to version 2.17. Use an access token from your workspace app with only t" --- > Documentation Index > Fetch the complete documentation index at: https://help.tooluse.net/llms.txt > Use this file to discover all available pages before exploring further. # Intercom

Read and manage permitted Intercom contacts, companies, conversations, articles, tickets and workspace resources using the official REST API pinned to version 2.17. Use an access token from your workspace app with only the required permissions. Creating or replying to messages can contact real users. Lists and searches preserve native pagination without automatic following. This connection uses the default api.intercom.io region; regional EU/Australia origins and unsupported uploads require a separate configuration.

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

Connect and use

Open the integration's connection form to check the available credential source. The source has not been resolved for this documentation export. The instructions below apply when using your own provider account.

Get your provider credentials

Follow these steps for Intercom, then enter the issued values in the connection form below.

  1. 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.

Official credential setup

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

Run Identify an admin with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve a macro — intercom.getmacro

Run Retrieve a macro with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

Full JSON Schema

Example input

{
  "path": {
    "id": "123"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List all macros — intercom.listmacros

Run List all macros with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set an admin to away — intercom.setawayadmin

Run Set an admin to away with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

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

Run List all activity logs with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Search activity logs — intercom.searchactivitylogs

Run Search activity logs with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

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

Run List all activity log event types with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

List all admins — intercom.listadmins

Run List all admins with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve an office hours exception — intercom.getofficehoursexception

Run Retrieve an office hours exception with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

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

Run Update an office hours exception with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

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

Run Delete an office hours exception with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

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

Run List all office hours exceptions with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

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

Run Create an office hours exception with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

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

Run Retrieve an office hours schedule with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

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

Run Update an office hours schedule with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

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

Run Delete an office hours schedule with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

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

Run List all office hours schedules with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create an office hours schedule — intercom.createofficehoursschedule

Run Create an office hours schedule with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

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

Run Retrieve an admin with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

Full JSON Schema

Example input

{
  "path": {
    "admin_id": 123
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Remove an admin — intercom.removeadmin

Run Remove an admin with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

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

Run List content import sources with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a content import source — intercom.createcontentimportsource

Run Create a content import source with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a content import source — intercom.deletecontentimportsource

Run Delete a content import source with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

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

Run Retrieve a content import source with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

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

Run Update a content import source with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

Full JSON Schema

Example input

{
  "path": {
    "source_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List external pages — intercom.listexternalpages

Run List external pages with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

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

Run Create an external page (or update an external page by external ID) with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete an external page — intercom.deleteexternalpage

Run Delete an external page with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

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

Run Retrieve an external page with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

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

Run Update an external page with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

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

Run Add a tag to an external page with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

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

Run Remove a tag from an external page with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

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

Run List all articles with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create an article — intercom.createarticle

Run Create an article with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve an article — intercom.retrievearticle

Run Retrieve an article with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

Full JSON Schema

Example input

{
  "path": {
    "article_id": 123
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update an article — intercom.updatearticle

Run Update an article with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

Full JSON Schema

Example input

{
  "path": {
    "article_id": 123
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete an article — intercom.deletearticle

Run Delete an article with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

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

Run Retrieve an article draft with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

Full JSON Schema

Example input

{
  "path": {
    "id": 123
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Stage an article draft — intercom.stagearticledraft

Run Stage an article draft with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

Full JSON Schema

Example input

{
  "path": {
    "id": 123
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Publish an article draft — intercom.publisharticledraft

Run Publish an article draft with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

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

Run Add a tag to an article with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

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

Run Remove a tag from an article with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

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

Run List article versions with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

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

Run Retrieve an article version with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

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

Run Search for articles with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

List all away status reasons — intercom.listawaystatusreasons

Run List all away status reasons with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

List all audiences — intercom.listaudiences

Run List all audiences with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create an audience — intercom.createaudience

Run Create an audience with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

Full JSON Schema

Example input

{
  "body": {
    "name": "VIP Customers"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve an audience — intercom.retrieveaudience

Run Retrieve an audience with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

Full JSON Schema

Example input

{
  "path": {
    "id": "123"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update an audience — intercom.updateaudience

Run Update an audience with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

Full JSON Schema

Example input

{
  "path": {
    "id": "123"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete an audience — intercom.deleteaudience

Run Delete an audience with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

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

Run Enqueue a new reporting data export job with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

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-

Run Get export job status with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

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

Run List available datasets and attributes with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Start a conversation with Fin — intercom.startfinconversation

Run Start a conversation with Fin with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

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": "john.doe@example.com"
    }
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Reply to Fin — intercom.replytofin

Run Reply to Fin with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

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": "john.doe@example.com"
    }
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Submit a CSAT rating — intercom.submitfincsat

Run Submit a CSAT rating with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

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

Run Discover Fin's capabilities with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

Full JSON Schema

Example input

{
  "body": {
    "user": {
      "id": "123456"
    }
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Ask Fin — intercom.askfin

Run Ask Fin with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

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": "john.doe@example.com"
    }
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Run a Fin procedure — intercom.runfinprocedure

Run Run a Fin procedure with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

Full JSON Schema

Example input

{
  "path": {
    "procedure_id": "12345"
  },
  "body": {
    "conversation_id": "ext-123",
    "user": {
      "id": "123456",
      "name": "John Doe",
      "email": "john.doe@example.com"
    }
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Escalate to a human — intercom.escalatefinconversation

Run Escalate to a human with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

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

Run List all redirects for a help center with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

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

Run Create a redirect with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

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

Run Retrieve a redirect with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

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

Run Delete a redirect with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

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

Run List all collections with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a collection — intercom.createcollection

Run Create a collection with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve a collection — intercom.retrievecollection

Run Retrieve a collection with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

Full JSON Schema

Example input

{
  "path": {
    "collection_id": 123
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a collection — intercom.updatecollection

Run Update a collection with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

Full JSON Schema

Example input

{
  "path": {
    "collection_id": 123
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a collection — intercom.deletecollection

Run Delete a collection with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

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

Run Retrieve a Help Center with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

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

Run List all Help Centers with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

List all articles — intercom.listinternalarticles

Run List all articles with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create an internal article — intercom.createinternalarticle

Run Create an internal article with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve an internal article — intercom.retrieveinternalarticle

Run Retrieve an internal article with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

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

Run Update an internal article with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

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

Run Delete an internal article with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

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

Run Add a tag to an internal article with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

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

Run Remove a tag from an internal article with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

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

Run Search for internal articles with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

List all folders — intercom.listfolders

Run List all folders with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a folder — intercom.createfolder

Run Create a folder with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve a folder — intercom.retrievefolder

Run Retrieve a folder with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

Full JSON Schema

Example input

{
  "path": {
    "id": 6
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a folder — intercom.updatefolder

Run Update a folder with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

Full JSON Schema

Example input

{
  "path": {
    "id": 6
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a folder — intercom.deletefolder

Run Delete a folder with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

Full JSON Schema

Example input

{
  "path": {
    "id": 6
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get IP allowlist settings — intercom.getipallowlist

Run Get IP allowlist settings with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update IP allowlist settings — intercom.updateipallowlist

Run Update IP allowlist settings with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create or Update a company — intercom.createorupdatecompany

Run Create or Update a company with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve companies — intercom.retrievecompany

Run Retrieve companies with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve a company by ID — intercom.retrieveacompanybyid

Run Retrieve a company by ID with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

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

Run Update a company with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

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

Run Delete a company with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

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

Run List attached contacts with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

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

Run List attached segments for companies with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

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

Run List all company notes with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

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

Run Create a company note with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

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

Run Search companies with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

List all companies — intercom.listallcompanies

Run List all companies with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Scroll over all companies — intercom.scrolloverallcompanies

Run Scroll over all companies with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Attach a Contact to a Company — intercom.attachcontacttoacompany

Run Attach a Contact to a Company with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

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

Run List attached companies for contact with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

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

Run Detach a contact from a company with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

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

Run List all notes with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

Full JSON Schema

Example input

{
  "path": {
    "contact_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a note — intercom.createnote

Run Create a note with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

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

Run List attached segments for contact with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

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

Run List subscriptions for a contact with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

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

Run Add subscription to a contact with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

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

Run Remove subscription from a contact with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

Full JSON Schema

Example input

{
  "path": {
    "contact_id": "63a07ddf05a32042dffac965",
    "subscription_id": "37846"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List tags attached to a contact — intercom.listtagsforacontact

Run List tags attached to a contact with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "contact_id": "63a07ddf05a32042dffac965"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add tag to a contact — intercom.attachtagtocontact

Run Add tag to a contact with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

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

Run Remove tag from a contact with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

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

Run List deleted contacts with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a contact — intercom.updatecontact

Run Update a contact with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

Full JSON Schema

Example input

{
  "path": {
    "contact_id": "63a07ddf05a32042dffac965"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a contact — intercom.showcontact

Run Get a contact with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

Full JSON Schema

Example input

{
  "path": {
    "contact_id": "63a07ddf05a32042dffac965"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a contact — intercom.deletecontact

Run Delete a contact with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

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

Run Merge a lead and a user with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Preview a contact merge — intercom.previewmergecontact

Run Preview a contact merge with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Search contacts — intercom.searchcontacts

Run Search contacts with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

List all contact activities — intercom.listcontactactivities

Run List all contact activities with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

List all contacts — intercom.listcontacts

Run List all contacts with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create contact — intercom.createcontact

Run Create contact with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a contact by External ID — intercom.showcontactbyexternalid

Run Get a contact by External ID with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

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

Run Archive contact with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

Full JSON Schema

Example input

{
  "path": {
    "contact_id": "63a07ddf05a32042dffac965"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Unarchive contact — intercom.unarchivecontact

Run Unarchive contact with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

Full JSON Schema

Example input

{
  "path": {
    "contact_id": "63a07ddf05a32042dffac965"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List banners for a contact — intercom.listcontactbanners

Run List banners for a contact with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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.id string Required The unique identifier of a contact.
headers object Optional additionalProperties: false
headers.Intercom-Version — Optional enum: ["2.17"]; $ref: "#/definitions/intercom_version"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Dismiss a banner for a contact — intercom.dismisscontactbanner

Run Dismiss a banner for a contact with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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.id string Required The unique identifier of a contact.
path.view_id string Required The view_id of the banner to dismiss, as returned by the list banners endpoint.
headers object Optional additionalProperties: false
headers.Intercom-Version — Optional enum: ["2.17"]; $ref: "#/definitions/intercom_version"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "id": "example",
    "view_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Block contact — intercom.blockcontact

Run Block contact with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

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

Run Get contact merge history with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

Full JSON Schema

Example input

{
  "path": {
    "id": "63a07ddf05a32042dffac965"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Bulk create contacts — intercom.bulkcreatecontacts

Run Bulk create contacts with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Bulk update contacts — intercom.bulkupdatecontacts

Run Bulk update contacts with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Bulk delete contacts — intercom.bulkdeletecontacts

Run Bulk delete contacts with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a bulk update job — intercom.showbulkupdatecontactsjob

Run Get a bulk update job with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

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

Run Run a bulk action on Knowledge Hub content with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

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

Run Search knowledge base contents with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

List all content snippets — intercom.listcontentsnippets

Run List all content snippets with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a content snippet — intercom.createcontentsnippet

Run Create a content snippet with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

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

Run Retrieve a content snippet with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

Full JSON Schema

Example input

{
  "path": {
    "id": "123"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a content snippet — intercom.updatecontentsnippet

Run Update a content snippet with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

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

Run Delete a content snippet with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

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

Run Add a tag to a content snippet with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

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

Run Remove a tag from a content snippet with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

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

Run List all dynamic content with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create dynamic content — intercom.createdynamiccontent

Run Create dynamic content with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

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

Run Retrieve dynamic content with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

Full JSON Schema

Example input

{
  "path": {
    "id": "123"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update dynamic content — intercom.updatedynamiccontent

Run Update dynamic content with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

Full JSON Schema

Example input

{
  "path": {
    "id": "123"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete dynamic content — intercom.deletedynamiccontent

Run Delete dynamic content with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

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

Run Add tag to a conversation with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

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

Run Remove tag from a conversation with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

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

Run List all conversations with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Creates a conversation — intercom.createconversation

Run Creates a conversation with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve a conversation — intercom.retrieveconversation

Run Retrieve a conversation with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

Full JSON Schema

Example input

{
  "path": {
    "conversation_id": 123
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a conversation — intercom.updateconversation

Run Update a conversation with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

Full JSON Schema

Example input

{
  "path": {
    "conversation_id": 123
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a conversation — intercom.deleteconversation

Run Delete a conversation with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

Full JSON Schema

Example input

{
  "path": {
    "conversation_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Search conversations — intercom.searchconversations

Run Search conversations with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Reply to a conversation — intercom.replyconversation

Run Reply to a conversation with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

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

Run Manage a conversation with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

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

Run Attach a contact to a conversation with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

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

Run Detach a contact from a group conversation with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

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

Run List handling events with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

Full JSON Schema

Example input

{
  "path": {
    "id": "123"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List HITL events — intercom.listhitlevents

Run List HITL events with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

Full JSON Schema

Example input

{
  "path": {
    "id": "123"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List side conversations — intercom.listsideconversations

Run List side conversations with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

Full JSON Schema

Example input

{
  "path": {
    "id": "123"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Redact a conversation part — intercom.redactconversation

Run Redact a conversation part with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Merge a conversation — intercom.mergeconversation

Run Merge a conversation with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

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

Run Convert a conversation to a ticket with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

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

Run List all deleted conversation IDs with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

List all conversation attributes — intercom.listconversationattributes

Run List all conversation attributes with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a conversation attribute — intercom.createconversationattribute

Run Create a conversation attribute with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

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

Run Get a conversation attribute with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

Full JSON Schema

Example input

{
  "path": {
    "id": 3
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a conversation attribute — intercom.updateconversationattribute

Run Update a conversation attribute with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

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

Run Delete (archive) a conversation attribute with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

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

Run Add an option to a list conversation attribute with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

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

Run Update an option on a list conversation attribute with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

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

Run Archive an option on a list conversation attribute with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

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

Run Create or Update a Custom Object Instance with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

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

Run List Custom Object Instances with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

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

Run Get Custom Object Instance by ID with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

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

Run Delete a Custom Object Instance by ID with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

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

Run List all data attributes with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a data attribute — intercom.createdataattribute

Run Create a data attribute with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a data attribute — intercom.updatedataattribute

Run Update a data attribute with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

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

Run List all data connectors with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a data connector — intercom.createdataconnector

Run Create a data connector with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve a data connector — intercom.retrievedataconnector

Run Retrieve a data connector with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

Full JSON Schema

Example input

{
  "path": {
    "id": "12345"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a data connector — intercom.deletedataconnector

Run Delete a data connector with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

Full JSON Schema

Example input

{
  "path": {
    "id": "12345"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a data connector — intercom.updatedataconnector

Run Update a data connector with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

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

Run List execution results for a data connector with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

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

Run Retrieve an execution result with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

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

Run List versions of a data connector with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

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

Run Retrieve a version of a data connector with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

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

Run Update the note on a data connector version with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

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

Run Submit a data event with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

List all data events — intercom.lisdataevents

Run List all data events with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

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

Run Create event summaries with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create content data export — intercom.createdataexport

Run Create content data export with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Show content data export — intercom.getdataexport

Run Show content data export with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

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

Run Cancel content data export with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

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

Run Download content data export with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

Full JSON Schema

Example input

{
  "path": {
    "job_identifier": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve job status — intercom.jobsstatus

Run Retrieve job status with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

Full JSON Schema

Example input

{
  "path": {
    "job_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a message — intercom.createmessage

Run Create a message with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve WhatsApp message delivery status — intercom.retrievewhatsappmessagestatus

Run Retrieve WhatsApp message delivery status with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

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

Run Get statuses of all messages sent based on the specified ruleset_id with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

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

Run List all news items with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a news item — intercom.createnewsitem

Run Create a news item with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve a news item — intercom.retrievenewsitem

Run Retrieve a news item with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

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

Run Update a news item with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

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

Run Delete a news item with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

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

Run List all live newsfeed items with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

Full JSON Schema

Example input

{
  "path": {
    "newsfeed_id": "123"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List all newsfeeds — intercom.listnewsfeeds

Run List all newsfeeds with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve a newsfeed — intercom.retrievenewsfeed

Run Retrieve a newsfeed with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

Full JSON Schema

Example input

{
  "path": {
    "newsfeed_id": "123"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve a note — intercom.retrievenote

Run Retrieve a note with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

Full JSON Schema

Example input

{
  "path": {
    "note_id": "34"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a note — intercom.deletenote

Run Delete a note with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

Full JSON Schema

Example input

{
  "path": {
    "note_id": "34"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List all segments — intercom.listsegments

Run List all segments with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve a segment — intercom.retrievesegment

Run Retrieve a segment with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

Full JSON Schema

Example input

{
  "path": {
    "segment_id": "123"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List subscription types — intercom.listsubscriptiontypes

Run List subscription types with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve a subscription type — intercom.getsubscriptiontype

Run Retrieve a subscription type with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

Full JSON Schema

Example input

{
  "path": {
    "id": "123"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a phone Switch — intercom.createphoneswitch

Run Create a phone Switch with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

List all calls — intercom.listcalls

Run List all calls with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a call — intercom.showcall

Run Get a call with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

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

Run Get call transcript by call id with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

Full JSON Schema

Example input

{
  "path": {
    "id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List calls with transcripts — intercom.listcallswithtranscripts

Run List calls with transcripts with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

Full JSON Schema

Example input

{
  "body": {
    "conversation_ids": [
      "64619700005694",
      "64619700005695"
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List all tags — intercom.listtags

Run List all tags with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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
query object Optional additionalProperties: false
query.id string Optional The unique identifier of a tag. When set, a single tag object is returned instead of a list.
query.taggable_type string Optional Set to user or company to list the tags applied to one contact or company instead of the whole workspace. Identify it with taggable_id, user_id, email, company_id or name. enum: ["user","company"]
query.taggable_id string Optional The Intercom id of the contact or company whose tags you want, used with taggable_type.
query.user_id string Optional The external id of the contact whose tags you want, used with taggable_type=user.
query.email string Optional The email address of the contact whose tags you want, used with taggable_type=user.
query.company_id string Optional The external id of the company whose tags you want, used with taggable_type=company.
query.name string Optional The name of the company whose tags you want, used with taggable_type=company.
headers object Optional additionalProperties: false
headers.Intercom-Version — Optional enum: ["2.17"]; $ref: "#/definitions/intercom_version"

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create or update a tag, Tag or untag companies, Tag contacts — intercom.createtag

Run Create or update a tag, Tag or untag companies, Tag contacts with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Find a specific tag — intercom.findtag

Run Find a specific tag with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

Full JSON Schema

Example input

{
  "path": {
    "tag_id": "123"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete tag — intercom.deletetag

Run Delete tag with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

Full JSON Schema

Example input

{
  "path": {
    "tag_id": "123"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List all teams — intercom.listteams

Run List all teams with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve a team — intercom.retrieveteam

Run Retrieve a team with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

Full JSON Schema

Example input

{
  "path": {
    "team_id": "123"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve team metrics — intercom.getteammetrics

Run Retrieve team metrics with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

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

Run List all ticket states with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

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

Run Create a new attribute for a ticket type with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

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

Run Update an existing attribute for a ticket type with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

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

Run List all ticket types with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a ticket type — intercom.createtickettype

Run Create a ticket type with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve a ticket type — intercom.gettickettype

Run Retrieve a ticket type with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

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

Run Update a ticket type with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

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

Run Reply to a ticket with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

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

Run Add tag to a ticket with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

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

Run Remove tag from a ticket with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

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

Run Link a conversation to a ticket with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

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

Run Unlink a conversation from a ticket with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

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

Run Create a ticket with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Enqueue create ticket — intercom.enqueuecreateticket

Run Enqueue create ticket with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a ticket — intercom.updateticket

Run Update a ticket with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

Full JSON Schema

Example input

{
  "path": {
    "ticket_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve a ticket — intercom.getticket

Run Retrieve a ticket with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

Full JSON Schema

Example input

{
  "path": {
    "ticket_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a ticket — intercom.deleteticket

Run Delete a ticket with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

Full JSON Schema

Example input

{
  "path": {
    "ticket_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Change ticket type — intercom.changetickettype

Run Change ticket type with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

Full JSON Schema

Example input

{
  "path": {
    "ticket_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Search tickets — intercom.searchtickets

Run Search tickets with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a visitor — intercom.updatevisitor

Run Update a visitor with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve a visitor with User ID — intercom.retrievevisitorwithuserid

Run Retrieve a visitor with User ID with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

Full JSON Schema

Example input

{
  "query": {
    "user_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Convert a visitor — intercom.convertvisitor

Run Convert a visitor with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

List all brands — intercom.listbrands

Run List all brands with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve a brand — intercom.retrievebrand

Run Retrieve a brand with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

Full JSON Schema

Example input

{
  "path": {
    "id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List all email settings — intercom.listemails

Run List all email settings with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve an email setting — intercom.retrieveemail

Run Retrieve an email setting with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

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

Run Register a Fin Voice call with Intercom. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

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

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Collect Fin Voice call by ID — intercom.collectfinvoicecallbyid

Run Collect Fin Voice call by ID with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

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

Run Collect Fin Voice call by external ID with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

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

Run Collect Fin Voice call by phone number with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

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

Run Collect Fin Voice calls by conversation ID with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

Full JSON Schema

Example input

{
  "path": {
    "conversation_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Export a workflow — intercom.exportworkflow

Run Export a workflow with Intercom. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

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

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.

Official provider documentation

Source: https://help.tooluse.net/integrations/intercom/index.mdx