Skip to content
Home
/
REST API Reference
/
Models
/
Error

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

Operations

Articles

Everything about your Articles

Operations

Companies

Everything about your Companies

Operations

Contacts

Everything about your contacts

Operations

Conversations

Everything about your Conversations

Operations

Data Attributes

Everything about your Data Attributes

Operations

Data Events

Everything about your Data Events

Operations

Data Export

Everything about your Data Exports

Operations

Help Center

Everything about your Help Center

Operations

Messages

Everything about your messages

Operations

News

Everything about your News

Operations

Notes

Everything about your Notes

Operations

Segments

Everything about your Segments

Operations

Subscription Types

Everything about subscription types

Operations

Switch

Everything about Switch

Operations

Tags

Everything about tags

Operations

Teams

Everything about your Teams

Operations

Visitors

Everything about your Visitors

Operations

Models

detach_contact_from_conversation_request

admin_idstringrequired

The id of the admin who is performing the action.

Example: "5017690"
{
  "admin_id": "5017690"
}

Error

The API will return an Error List for a failed request, which will contain one or more Error objects.

typestringrequired

The type is error.list

Example: "error.list"
request_idstring or null(uuid)
Example: "f93ecfa8-d08a-4325-8694-89aeb89c8f85"
errorsArray of objectsrequired

An array of one or more error objects

errors[].​codestringrequired

A string indicating the kind of error, used to further qualify the HTTP response code

Example: "unauthorized"
errors[].​messagestring or null

Optional. Human readable description of the error.

Example: "Access Token Invalid"
errors[].​fieldstring or null

Optional. Used to identify a particular field or query parameter that was in error.

Example: "email"
{
  "type": "error.list",
  "request_id": "f93ecfa8-d08a-4325-8694-89aeb89c8f85",
  "errors": [
    { … }
  ]
}

File

The value describing a file upload set for a custom attribute

typestring
Example: "upload"
namestring

The name of the file

Example: "Screenshot.png"
urlstring

The url of the file. This is a temporary URL and will expire after 30 minutes.

Example: "https://intercom-attachments-1.com/.../Screenshot.png"
content_typestring

The type of file

Example: "image/png"
filesizeinteger

The size of the file in bytes

Example: 11308309
widthinteger

The width of the file in pixels, if applicable

Example: 3024
heightinteger

The height of the file in pixels, if applicable

Example: 1964
{
  "type": "upload",
  "name": "Screenshot.png",
  "url": "https://intercom-attachments-1.com/.../Screenshot.png",
  "content_type": "image/png",
  "filesize": 11308309,
  "width": 3024,
  "height": 1964
}