Skip to main content
PATCH
Partially Update a Conversation

Authorizations

Authorization
string
header
required

Token-based authentication with required prefix "Token"

Path Parameters

id
string<uuid>
required

Body

id
string

The UUID of the Conversation.

contact
string<uuid>
status
enum<string>
Available options:
CREATED,
FLOW,
FLOW_PAUSED,
NEW,
IN_PROGRESS,
RESOLVED,
CLOSED
assigned
object[]

The Users assigned to the Conversation.

tags
object[]

The Tags assigned to the Conversation.

assigned_team
integer

The ID of the Team assigned to the Conversation.

channel
integer | null

Response

200 - application/json
id
string
required

The UUID of the Conversation.

contact
string<uuid>
required
assigned
object[]
required

The Users assigned to the Conversation.

created_on
string<date-time>
required
read-only
source
enum<string>
required
Available options:
INBOX,
AUTO_RESPONSE,
API,
BROADCAST,
FLOW,
UNKNOWN
status
enum<string>
Available options:
CREATED,
FLOW,
FLOW_PAUSED,
NEW,
IN_PROGRESS,
RESOLVED,
CLOSED
tags
object[]

The Tags assigned to the Conversation.

assigned_team
integer

The ID of the Team assigned to the Conversation.

channel
integer | null