Skip to content
Home/
REST API Reference
/
/
Update Conversation Reque...

Update Conversation Request

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"
prioritystring

The priority level to set on the conversation. Accepts one of none, low, medium, high, or urgent. Set none to clear an existing priority.

Enum:"none""low""medium""high""urgent"
Example:"high"
admin_idstring

The ID of the teammate to attribute the priority change to. Defaults to Operator when omitted, and is only used alongside priority.

Example:"394051"
custom_attributesobject(Custom Attributes (write))

The custom attributes which are set on this object, as key-value pairs. For relationship attributes the value should be a list of custom object instance models. Only attributes a caller may set should be sent here — attributes Intercom generates are returned in responses only.

Example:
{
  "paid_subscriber": true,
  "monthly_spend": 155.5,
  "team_mates": 9,
  "start_date_iso8601": "2023-03-04T09:46:14Z",
  "end_date_timestamp": 1677923174
}
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",
  "priority": "high",
  "admin_id": "394051",
  "custom_attributes": {
    "paid_subscriber": true,
    "monthly_spend": 155.5,
    "team_mates": 9,
    "start_date_iso8601": "2023-03-04T09:46:14Z",
    "end_date_timestamp": 1677923174
  },
  "company_id": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632"
}