Change Chat Labels

Supported & Tested

Adds or removes WhatsApp labels from a chat.

POSThttps://api.waplix.io/api/v1/labels/chat-change

Authentication

Authorization: Bearer YOUR_API_KEY

Parameters Specification

Parameter	Type	Required	Description
instance_id	`string`	Required	Required Waplix instance id
chat_id	`string`	Required	Required WhatsApp chat id
add_labels	`string`	Optional	Optional array of label ids to add
remove_labels	`string`	Optional	Optional array of label ids to remove

instance_id

stringReq

Required Waplix instance id

chat_id

stringReq

Required WhatsApp chat id

add_labels

stringOpt

Optional array of label ids to add

remove_labels

stringOpt

Optional array of label ids to remove

Usage Notes

add_labels and/or remove_labels are required. Passing only label_ids is not supported. Verified on production instance 29854.

Request Payload Example

Request

curl -X POST "https://api.waplix.io/api/v1/api/v1/labels/chat-change" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Success Response

Response · 200 OK

"15551234567@s.whatsapp.net"

Previous Get Label by ID Next Overview

Was this page helpful?