Update a Chat

patch

https://api.unipile.com/v2/{account_id}/chats/{chat_id}

Updates the specified chat by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

chat_id

string

required

length ≥ 1

ID of the Chat to update.

account_id

string

required

^acc_(.*)$

ID of the Account (acc_xxx) to call the method on behalf of.

Body Params

name

string

A custom name for the chat. Some providers allow custom names only on groups.

pin_status

boolean

If supported, set to true to pin the chat at the top of the list, or false to unpin it.

archive_status

boolean

If supported, set to true to archive the chat, or false to move it back to the main inbox.

label

string

If supported, associate the chat with the given label. For Whatsapp, this is resolved by label name and created if missing.

muted_until

If supported, the date until which the conversation should be muted. Else true to mute the chat for an indefinite time, else false to un-mute an already muted chat.

read_status

boolean

Set to true to mark the chat as read. This is useful when displaying the list of messages in your app. Set to false to mark the chat as unread.

Response

200Default Response