The intercom API reference.
Intercom API (2.11)
Download OpenAPI description
Overview
URL
License
Languages
Servers
The production API server
https://api.intercom.io/
The european API server
https://api.eu.intercom.io/
The australian API server
https://api.au.intercom.io/
Admins
A list of admins associated with a given workspace.
String representing the object's type. Always has the value admin.list.
Value"admin.list"
Example: "admin.list"
A list of admins associated with a given workspace.
String representing the object's type. Always has the value admin.
Value"admin"
Example: "admin"
Identifies if this admin is currently set in away mode.
Example: false
Identifies if this admin is set to automatically reassign new conversations to the apps default inbox.
Example: false
Identifies if this admin has a paid inbox seat to restrict/allow features that require them.
Example: true
This object represents the avatar associated with the admin.
Example: [814865]
Image for the associated team or teammate
Example: "https://picsum.photos/200/300"
{ "type": "admin.list", "admins": [ { … } ] }
Admin Reply
Payload of the request to reply on behalf of an admin
The text body of the reply. Notes accept some HTML formatting. Must be present for comment and note message types.
Example: "Hello there!"
The time the reply was created. If not provided, the current time will be used.
Example: 1590000000
A list of image URLs that will be added as attachments. You can include up to 10 URLs.
{ "message_type": "comment", "type": "admin", "body": "Hello there!", "admin_id": "3156780", "created_at": 1590000000, "attachment_urls": [ "http://example.com" ], "attachment_files": [ { … } ] }