Skip to content
Home/
REST API Reference
/
/
Conversation attachment f...

Intercom API (2.9)

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

Ticket Type Attributes

Everything about your ticket type attributes

Operations

Ticket Types

Everything about your ticket types

Operations

Tickets

Everything about your tickets

SchemasOperations

Visitors

Everything about your Visitors

Operations

Models

Schemas

Contact Unarchived

unarchived contact object

typestring

always contact

Value"contact"
Example: "contact"
idstring

The unique identifier for the contact which is given by Intercom.

Example: "5ba682d23d7cf92bef87bfd4"
external_idstring or null

The unique identifier for the contact which is provided by the Client.

Example: "f3b87a2e09d514c6c2e79b9a"
archivedboolean

Whether the contact is archived or not.

Example: false
{
  "type": "contact",
  "id": "5ba682d23d7cf92bef87bfd4",
  "external_id": "f3b87a2e09d514c6c2e79b9a",
  "archived": false
}

Conversation attachment files

Properties of the attachment files in a conversation part

content_typestring

The content type of the file

Example: "application/json"
datastring

The base64 encoded file data.

Example: "ewogICJ0ZXN0IjogMQp9"
namestring

The name of the file.

Example: "test.json"
{
  "content_type": "application/json",
  "data": "ewogICJ0ZXN0IjogMQp9",
  "name": "test.json"
}

Contacts

The list of contacts (users or leads) involved in this conversation. This will only contain one customer unless more were added via the group conversation feature.

typestring
Value"contact.list"
Example: "contact.list"
contactsArray of objects(Contact Reference)

The list of contacts (users or leads) involved in this conversation. This will only contain one customer unless more were added via the group conversation feature.

{
  "type": "contact.list",
  "contacts": [
    { … }
  ]
}