v1

latestOpenAPI 3.1.02026-07-1413113265.9 KB
message

get pinned messages

Retrieves all pinned messages from a specified chat.

post/instances/{id}/client/action/get-pinned-messages

Path parameters

idinteger required

Instance ID

Request body

chatIdstring required

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

Example request

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

Response

Pinned messages retrieved successfully

status'success' | 'error'
instanceIdstring

Example response

{
  "status": "success",
  "instanceId": "1"
}