label

change chat labels

Add or remove labels on a chat.

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

Request

  • Base URL: https://waapi.app/api/v1
  • URL: https://waapi.app/api/v1/instances/{id}/client/action/change-chat-labels
  • Auth: HTTP bearer

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

Request reached the instance. data.status reports whether the action was carried out; on error data carries message and explanation. Payload: Labels changed successfully.

status'success' | 'error'

Whether the request reached the instance. success here does not mean the action was carried out — that is reported by data.status, which is the authoritative one. A malformed input arrives as status: success with data.status: error.

Example response

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

Changes

No recorded changes to this operation across all 1 revision of this API.