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.
{% admonition type="warning" name="Messages from contacts" %} from should be an admin. A request with a user or lead as from is not rejected: it creates a conversation initiated by that contact, as the Create a conversation endpoint (POST /conversations) does, and the to, cc and bcc fields are ignored. To create a conversation initiated by a contact, use POST /conversations. {% /admonition %}
Request
- Base URLhttps://api.intercom.io
- AuthHTTP bearer
Headers
Intercom API version.</br>By default, it's equal to the version set in the app package.
Request body
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
Example response
{
"type": "user_message",
"id": "1488971108",
"created_at": 1667560812,
"subject": "Greetings",
"body": "Hello",
"message_type": "inapp",
"conversation_id": "64619700005570"
}Changes
No recorded changes to this operation across all 96 revisions of this API.