PUT /conversations/{id}
You can update an existing conversation.
{% admonition type="info" name="Replying and other actions" %} If you want to reply to a coveration or take an action such as assign, unassign, open, close or snooze, take a look at the reply and manage endpoints. {% /admonition %}
Servers
- https://api.intercom.io
- https://api.eu.intercom.io
- https://api.au.intercom.io
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id |
Integer | Yes |
The id of the conversation to target |
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" |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
display_as |
String | No |
Set to plaintext to retrieve conversation messages in plain text. |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
custom_attributes |
Object | No |
An object containing the different custom attributes associated to the conversation as key-value pairs. For relationship attributes the value will be a list of custom object instance models. |
custom_attributes.custom_object_instance_list |
Object | No |
The list of associated custom object instances for a given reference attribute on the parent object. |
custom_attributes.custom_object_instance_list.type |
String | No | |
custom_attributes.custom_object_instance_list.instances[] |
Array | No |
The list of associated custom object instances for a given reference attribute on the parent object. |
custom_attributes.custom_object_instance_list.instances[].id |
String | No |
The Intercom defined id representing the custom object instance. |
custom_attributes.custom_object_instance_list.instances[].custom_attributes |
Object | No |
The custom attributes you have set on the custom object instance. |
custom_attributes.custom_object_instance_list.instances[].external_id |
String | No |
The id you have defined for the custom object instance. |
custom_attributes.custom_object_instance_list.instances[].type |
String | No |
The identifier of the custom object type that defines the structure of the custom object instance. |
read |
Boolean | No |
Mark a conversation as read within Intercom. |
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.