Sign in

v1

latestOpenAPI 3.1.02026-07-1413113265.9 KB
label

change chat labels

Add or remove labels on a chat.

post/instances/{id}/client/action/change-chat-labels

Path parameters

idinteger required

Instance ID

Request body

chatIdstring required

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

labelIdsinteger[] required

Array of label IDs to assign to the chat

Example request

{
  "chatId": "50664083362@c.us",
  "labelIds": [
    1,
    2
  ]
}

Response

Labels changed successfully

status'success' | 'error'

Example response

{
  "data": {
    "status": "success",
    "data": {
      "labelsChanged": true
    }
  },
  "status": "success"
}