Home
/
REST API Reference
/
Conversations
/
Creates a conversation

Creates a conversation

You can create a conversation that has been initiated by a contact (ie. user or lead). The conversation can be an in-app message only.

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.

SecurityHTTP: bearerAuth
Request
header Parameters
Intercom-Version
string (intercom_version)
Default: 2.10

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

Enum: "1.0" "1.1" "1.2" "1.3" "1.4" "2.0" "2.1" "2.2" "2.3" "2.4" "2.5" "2.6" "2.7" "2.8" "2.9" "2.10" "Unstable"
Example: 2.10
Request Body schema: application/json
required
object
body
required
string

The content of the message. HTML is not supported.

post
/conversations
Request samples
application/json
{
"from": {
"type": "user",
"id": "660e72f96abd01bd27af618d"
},
"body": "Hello there"
}
Responses

200

conversation created

Response Schema: application/json
type
required
string

The type of the message

id
required
string

The id representing the message.

created_at
required
integer <date-time>

The time the conversation was created.

subject
string

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

body
required
string

The message body, which may contain HTML.

message_type
required
string

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

Enum: "email" "inapp" "facebook" "twitter"
conversation_id
string

The associated conversation_id

401

Unauthorized

403

API plan restricted

404

Contact Not Found

Response samples
application/json
{
"type": "user_message",
"id": "403920837",
"created_at": 1712222969,
"body": "Hello there",
"message_type": "inapp",
"conversation_id": "4780"
}