Update Conversation Request

Home/

REST API Reference

Payload of the request to update a conversation

readboolean

Mark a conversation as read within Intercom.

Example:true

titlestring

The title given to the conversation

Example:"Conversation Title"

custom_attributesobject(Custom Attributes)

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. System-defined attributes such as "CX Score rating" and "CX Score explanation" may also be included.

Example:

{
  "paid_subscriber": true,
  "monthly_spend": 155.5,
  "team_mates": 9,
  "start_date_iso8601": "2023-03-04T09:46:14Z",
  "end_date_timestamp": 1677923174,
  "CX Score rating": 4,
  "CX Score explanation": "The conversation was resolved quickly and the customer expressed satisfaction with the outcome."
}

company_idstring

The ID of the company that the conversation is associated with. The unique identifier for the company which is given by Intercom. Set to nil to remove company.

Example:"5f4d3c1c-7b1b-4d7d-a97e-6095715c6632"

{
  "read": true,
  "title": "Conversation Title",
  "custom_attributes": {
    "paid_subscriber": true,
    "monthly_spend": 155.5,
    "team_mates": 9,
    "start_date_iso8601": "2023-03-04T09:46:14Z",
    "end_date_timestamp": 1677923174,
    "CX Score rating": 4,
    "CX Score explanation": "The conversation was resolved quickly and the customer expressed satisfaction with the outcome."
  },
  "company_id": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632"
}