Sign in

v51

latestOpenAPI 3.0.1MITraw.githubusercontent.com2026-08-01150230854.3 KB
Messages

Create a message

You can create a message that has been initiated by an admin. The conversation can be either an in-app message or an email.

🚧 Sending for visitors

There can be a short delay between when a contact is created and when a contact becomes available to be messaged through the API. A 404 Not Found error will be returned in this case.

This will return the Message model that has been created.

🚧 Retrieving Associated Conversations

As this is a message, there will be no conversation present until the contact responds. Once they do, you will have to search for a contact's conversations with the id of the message.

post/messages

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

OR

Example request

{
  "message_type": "in_app",
  "subject": "Thanks for everything",
  "body": "Hello there",
  "template": "plain",
  "from": {
    "type": "admin",
    "id": 394051
  },
  "to": {
    "type": "user",
    "id": "536e564f316c83104c000020"
  },
  "cc": {
    "type": "user",
    "id": "536e564f316c83104c000020"
  },
  "bcc": {
    "type": "user",
    "id": "536e564f316c83104c000020"
  },
  "created_at": 1590000000,
  "create_conversation_without_contact_reply": true
}

Response

admin message 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"
}