Sign in

v1

latestOpenAPI 3.1.02026-07-1413113265.9 KB
chat

pin chat

Pins a chat to the top of the chat list. The operation may fail if the maximum number of pinned chats (3) has been reached.

post/instances/{id}/client/action/pin-chat

Path parameters

idinteger required

The ID of the instance

Request body

chatIdstring required

Chat ID <countrycode_short><usernumber>@c.us or @g.us for groups

Example request

{
  "chatId": "50664083362@c.us"
}

Response

Successfully pinned the chat

status'success' | 'error'
instanceIdstring

ID of the instance

Example response

{
  "status": "success",
  "instanceId": "1",
  "data": {
    "chatPinned": true,
    "message": "Chat pinned successfully"
  }
}