Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-phone
string

Please provide the number of the phone you want to call with this API in the header. The number must be in country code + number format without any characters or spaces, e.g. 919876543210; Alternatively, provide the phone_id (phone-xxxxxxxxxxxx) in the header

Path Parameters

chat_id
string
required
  • The unique id of the chat
  • For individual chats, this would be the country_code + number (e.g., 918527184400), followed by @c.us
  • For groups, this would end with @g.us

Body

application/json
assigned_to
string
  • Update the assignee of the chat. The assignee must be a valid email address of a user in the organization
custom_properties
object
  • A record (key-value pair) of the property name or property id as keys, along with the updated value
labels
string
  • A comma-separated list of labels to be assigned to the chat. All labels are case-insensitive.
  • If any label currently does not exist, it will be created

Response

200 - application/json

The response is a chat object. Refer to the chat object here