Home
/
REST API Reference
/
Models
/
Reference

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

redact_conversation_request

One of:

Payload of the request to redact a conversation part

typestringrequired

The type of resource being redacted.

Value"conversation_part"
Example: "conversation_part"
conversation_idstringrequired

The id of the conversation.

Example: "19894788788"
conversation_part_idstringrequired

The id of the conversation_part.

Example: "19381789428"
{
  "type": "conversation_part",
  "conversation_id": "19894788788",
  "conversation_part_id": "19381789428"
}

Reference

reference to another object

typestring
Example: "contact"
idstring or null
Example: "1a2b3c"
{
  "type": "contact",
  "id": "1a2b3c"
}

reply_conversation_request

One of:
One of:

Payload of the request to reply on behalf of a contact using their intercom_user_id

intercom_user_idstringrequired

The identifier for the contact as given by Intercom.

attachment_filesArray of objects(Conversation attachment files)

A list of files that will be added as attachments.

message_typestringrequired
Value"comment"
typestringrequired
Value"user"
bodystringrequired

The text body of the comment.

attachment_urlsArray of strings(uri)(Attachment URLs)<= 10 items

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

{
  "intercom_user_id": "string",
  "attachment_files": [
    { … }
  ],
  "message_type": "comment",
  "type": "user",
  "body": "string",
  "attachment_urls": [
    "http://example.com"
  ]
}