INintercom
Conversations

Creates a conversation

Changed on

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.

{% admonition type="info" name="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. {% /admonition %}

This will return the Message model that has been created.

post/conversations

Request

  • Base URL
    https://api.intercom.io
  • Auth
    HTTP bearer

Headers

Intercom-Version'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' | '2.11' | '2.12' | '2.13' | '2.14'

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

Example:2.14

Request body

bodystring required

The content of the message. HTML is not supported.

subjectstring

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

attachment_urlsstring[]

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

created_atinteger

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 request

{
  "from": {
    "type": "user",
    "id": "536e564f316c83104c000020"
  },
  "body": "Hello",
  "subject": "Thanks for everything",
  "created_at": 1671028894
}

Response

conversation created

typestring required

The type of the message

idstring required

The id representing the message.

created_atinteger required

The time the conversation was created.

subjectstring

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

bodystring required

The message body, which may contain HTML.

message_type'email' | 'inapp' | 'facebook' | 'twitter' required

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

conversation_idstring

The associated conversation_id

Example response

{
  "type": "user_message",
  "id": "1488971108",
  "created_at": 1667560812,
  "subject": "Greetings",
  "body": "Hello",
  "message_type": "inapp",
  "conversation_id": "64619700005570"
}

Changes

  • 2.140bb528ef23e2Revision changes
    • info

      added the new optional request property

  • 2.1436dacdde4f5bRevision changes
    • breaking

      the response's body type changed from object to no type for status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added to the response body allOf list for the response status