Skip to main content
PATCH

Authorizations

X-API-KEY
string
header
required

Path Parameters

id
string
required

Worker ID

chat_id
string
required

Chat ID

Body

application/json
name
string

New chat name.

members
string[]

Updated array of worker IDs. Replaces the current member list.

Response

OK

id
string

Chat ID.

name
string

Chat name.

chat_admin
integer

Whether the current worker is the chat admin.

Required range: 0 <= x <= 1
silenced
integer

Whether the chat is silenced for the current worker.

Required range: 0 <= x <= 1
on_chat
integer

Whether the current worker is on the chat.

Required range: 0 <= x <= 1
locked
integer

Whether the chat is locked.

Required range: 0 <= x <= 1
date_created
string<date-time>

Timestamp when the chat was created.

most_recent_message_id
string | null

ID of the most recent message.

last_message_timestamp
string<date-time> | null

Timestamp of the most recent message.

message
string | null

Preview of the most recent message.

name_first
string | null

First name of the most recent message sender.

selected_picture_location
string | null

Profile picture URL of the most recent message sender.

chats_order
string<date-time>

Sort timestamp for chat ordering.

unread_count
integer

Number of unread messages.

Required range: x >= 0
members
object[]

List of chat members.