API ReferenceBuilding AppsInstalling IntercomAPI & Webhook ReferenceCanvas Kit Reference
DocsApp StoreForumBlogYour Apps

Create a conversation

Example Request & Response

$ curl https://api.intercom.io/conversations \
-X POST \
-H 'Authorization:Bearer <Your access token>' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' -d

{
  "from": {
    "type": "user",
    "id": "536e564f316c83104c000020"
  },
  "body": "Hey"
}
HTTP/1.1 200 OK
{
  "type": "user_message",
  "id": "2001",
  "created_at": 1401917202,
  "body" : "Hey, is the new thing in stock?",
  "message_type": "inapp",
  "conversation_id": "36000324324"
}
intercom.messages.create(
  :from => {
    :type => "user",
    :id => "536e564f316c83104c000020"
  },
  :body => "Hey"
)
<?php
$intercom->messages->create([
    "message_type" => "inapp",
    "body" => "Surely, I said, knowledge is the food of the soul",
    "from" => [
        "type" => "user",
        "id" => "5989303470da497b1babb9ef"
    ]
]);
?>
UserMessage userMessage = new UserMessage()
  .setBody("Hey! Is there, is there a reward?")
  .setUser(user);
Conversation.create(userMessage);

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.

Request Body Parameters

ParamaterTypeRequired?Description
fromObjectYesSee Form Object below for more.
bodyStringYesThe content of the message.
HTML is not supported.

From Object

AttributeTypeRequired?Description
typeStringYesThe role associated to the contact - user or lead.
idStringYesThe identifier for the contact which is given by Intercom.

Response

This will return the Message model that has been created.