Sign in

v1

latestOpenAPI 3.0.02026-07-26254134307.1 KB
Conversations

Update conversation

Update a conversation.

Required scope: conversations:write

patch/conversations/{conversation_id}

Path parameters

conversation_idstring required

The conversation ID

Request body

assignee_idstring

ID of the teammate to assign the conversation to. Set it to null to unassign.

inbox_idstring

ID of the inbox to move the conversation to.

status'archived' | 'open' | 'deleted' | 'spam'

New status of the conversation

status_idstring

Unique identifier of the status to set the conversation to. Only one of status and status_id should be provided. Ticketing must be enabled for the company to use this field.

tag_idsResourceID[]

List of all the tag IDs replacing the old conversation tags

descriptionstring nullable

Description of the task. Only allowed on task conversations. Set to null to clear.

due_atnumber nullable

Unix timestamp in seconds when the task is due. Must be in the future and within 50 years. Only allowed on task conversations. Set to null to clear.

custom_fieldsCustomFieldParameter

An object whose key is the name property defined for the custom field in the Front UI. The value of the key must use the same type specified for the custom field, as described in https://dev.frontapp.com/reference/custom-fields

Example request

{
  "status_id": "sts_123",
  "due_at": 1701292649.333,
  "custom_fields": {
    "city": "London, UK",
    "isVIP": true,
    "renewal_date": 1525417200,
    "sla_time": 90,
    "owner": "leela@planet-express.com",
    "replyTo": "inb_55c8c149",
    "Job Title": "firefighter"
  }
}

Response

No content