POST /conversations
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.
Servers
- https://api.intercom.io
- https://api.eu.intercom.io
- https://api.au.intercom.io
Request headers
| 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:
Default value: "2.12" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
body |
String | Yes |
The content of the message. HTML is not supported. |
created_at |
Integer | No |
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. |
from |
Object | Yes | |
from.id |
String | Yes |
The identifier for the contact which is given by Intercom. |
from.type |
String | Yes |
The role associated to the contact - user or lead. Possible values:
|
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.