Creates a conversation

Request

You can create a conversation that has been initiated by a contact (ie. user or lead).

Sending for visitors

You can also send a message from a visitor by specifying their user_id or id value in the from field, along with a type field value of contact. This visitor will be automatically converted to a contact with a lead role once the conversation is created.

This will return the Message model that has been created.

Security

bearerAuth

Intercom-Versionstring(intercom_version)

Intercom API version.
By default, it's equal to the version set in the app package.

Default:"2.11"

Enum:"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"

Example:2.11

Bodyapplication/json

fromobjectrequired

bodystringrequired

The content of the message. HTML is not supported.

Example:"Hello"

subjectstring

The title of the email. Only applicable if the message type is email.

Example:"Thanks for everything"

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.

created_atinteger, (date-time)

The time the conversation was created as a UTC Unix timestamp. If not provided, the current time will be used. This field is only recommneded for migrating past conversations from another source into Intercom.

Example:1671028894

message_typestring

The kind of message being created. Values: inapp (in-app messaging), email, sms, whatsapp, or facebook.

Enum:"inapp""email""sms""whatsapp""facebook"

Example:"inapp"

curl -i -X POST \
  https://api.intercom.io/conversations \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Intercom-Version: 2.11' \
  -d '{
    "from": {
      "type": "user",
      "id": "667d60d18a68186f43bafddd"
    },
    "body": "Hello there"
  }'

Responses

conversation created

Bodyapplication/json

typestringrequired

The type of the message

Example:"user_message"

idstringrequired

The id representing the message.

Example:"1488971108"

created_atinteger, (date-time)required

The time the conversation was created.

Example:1667560812

subjectstringrequired

The subject of the message. Only present if message_type: email.

Example:"Greetings"

bodystringrequired

The message body, which may contain HTML.

Example:"Hello"

message_typestringrequired

The type of message that was sent. Can be email, inapp or facebook.

Enum:"email""inapp""facebook"

Example:"inapp"

conversation_idstringrequired

The associated conversation_id

Example:"64619700005570"

Response

{
  "type": "user_message",
  "id": "403918251",
  "created_at": 1719492819,
  "body": "Hello there",
  "message_type": "inapp",
  "conversation_id": "363"
}