Skip to content
Home/
REST API Reference
/
/
Admins

Intercom API (2.7)

The intercom API reference.

Download OpenAPI description
api.intercom.io.json
api.intercom.io.yaml
Overview
URL

https://developers.intercom.com

License

MIT

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

Everything about your Admins

SchemasOperations

Articles

Everything about your Articles

SchemasOperations

Companies

Everything about your Companies

SchemasOperations

Contacts

Everything about your contacts

SchemasOperations

Conversations

Everything about your Conversations

SchemasOperations

Data Attributes

Everything about your Data Attributes

SchemasOperations

Data Events

Everything about your Data Events

SchemasOperations

Data Export

Everything about your Data Exports

SchemasOperations

Help Center

Everything about your Help Center

SchemasOperations

Messages

Everything about your messages

SchemasOperations

News

Everything about your News

SchemasOperations

Notes

Everything about your Notes

SchemasOperations

Segments

Everything about your Segments

SchemasOperations

Subscription Types

Everything about subscription types

SchemasOperations

Switch

Everything about Switch

Operations

Tags

Everything about tags

SchemasOperations

Teams

Everything about your Teams

SchemasOperations

Visitors

Everything about your Visitors

Operations

Models

Schemas

Addressable List

A list used to access other resources from a parent model.

typestring(uri)

The addressable object type

Example: "note"
idstring

The id of the addressable object

Example: "123"
urlstring(uri)

Url to get more company resources for this contact

Example: "/contacts/5ba682d23d7cf92bef87bfd4/notes"
{
  "type": "note",
  "id": "123",
  "url": "/contacts/5ba682d23d7cf92bef87bfd4/notes"
}

Admins

A list of admins associated with a given workspace.

typestring

String representing the object's type. Always has the value admin.list.

Example: "admin.list"
adminsArray of objects or null(Admin)

A list of admins associated with a given workspace.

{
  "type": "admin.list",
  "admins": [
    { … }
  ]
}

Admin Reply

Payload of the request to reply on behalf of an admin

message_typestringrequired
Enum"comment""note"
typestringrequired
Value"admin"
Example: "admin"
bodystring

The text body of the reply. Notes accept some HTML formatting. Must be present for comment and note message types.

Example: "Hello there!"
admin_idstringrequired

The id of the admin who is authoring the comment.

Example: "3156780"
created_atinteger

The time the reply was created. If not provided, the current time will be used.

Example: 1590000000
attachment_urlsArray of strings(uri)<= 10 items

A list of image URLs that will be added as attachments. You can include up to 10 URLs.

attachment_filesArray of objects(Conversation attachment files)<= 10 items

A list of files that will be added as attachments. You can include up to 10 files

{
  "message_type": "comment",
  "type": "admin",
  "body": "Hello there!",
  "admin_id": "3156780",
  "created_at": 1590000000,
  "attachment_urls": [
    "http://example.com"
  ],
  "attachment_files": [
    { … }
  ]
}