POST /messages

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.

Servers

https://api.intercom.io
https://api.eu.intercom.io
https://api.au.intercom.io

Request headers

Name Type Required Description

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"
`Intercom-Version`	String	No	Possible values: `"1.1"` `"2.0"` `"1.0"` `"2.9"` `"Unstable"` `"1.3"` `"2.2"` `"2.12"` `"1.2"` `"2.1"` `"2.4"` `"1.4"` `"2.3"` `"2.6"` `"2.5"` `"2.8"` `"2.10"` `"2.7"` `"2.11"` Default value: "2.12"

Content-Type

String

Yes

The media type of the request body.

Default value: "application/json"

Intercom-Version

String

Possible values:

"1.1"
"2.0"
"1.0"
"2.9"
"Unstable"
"1.3"
"2.2"
"2.12"
"1.2"
"2.1"
"2.4"
"1.4"
"2.3"
"2.6"
"2.5"
"2.8"
"2.10"
"2.7"
"2.11"

Default value: "2.12"

Request body fields

Name	Type	Required	Description
`to`	Object	No	The sender of the message. If not provided, the default sender will be used.
`to.id`	String	Yes	The identifier for the contact which is given by Intercom.
`to.type`	String	Yes	The role associated to the contact - `user` or `lead`. Possible values: `"lead"` `"user"`
`template`	String	No	The style of the outgoing message. Possible values `plain` or `personal`.
`create_conversation_without_contact_reply`	Boolean	No	Whether a conversation should be opened in the inbox for the message without the contact replying. Defaults to false if not provided. Default value: false
`body`	String	No	The content of the message. HTML and plaintext are supported.
`subject`	String	No	The title of the email.
`created_at`	Integer	No	The time the message was created. If not provided, the current time will be used.
`message_type`	String	No	The kind of message being created. Values: `in_app` or `email`. Possible values: `"email"` `"in_app"`
`from`	Object	No	The sender of the message. If not provided, the default sender will be used.
`from.id`	Integer	Yes	The identifier for the admin which is given by Intercom.
`from.type`	String	Yes	Always `admin`. Possible values: `"admin"`

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.