Add a label to a chat
Attaches an existing label to a chat for the connected account via a WhatsApp app-state patch.
Attaches an existing label to a chat for the connected account via a WhatsApp app-state patch.
Authorization
bearerAuth Per-user API token (UUID v4) sent as Authorization: Bearer <token>. Identifies the tenant and user.
In: header
Path Parameters
Target chat JID (user or group).
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Payload for attaching a label to a chat.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/chats/5511999999999@s.whatsapp.net/labels" \ -H "Content-Type: application/json" \ -d '{ "label_id": "1" }'{ "success": true, "chat_jid": "5511999999999@s.whatsapp.net", "label_id": "1", "labeled": true}{ "success": false, "error": "validation failed", "error_code": "VALIDATION_ERROR", "timestamp": "2026-06-15T12:00:00Z"}{ "success": false, "error": "validation failed", "error_code": "VALIDATION_ERROR", "timestamp": "2026-06-15T12:00:00Z"}{ "success": false, "error": "validation failed", "error_code": "VALIDATION_ERROR", "timestamp": "2026-06-15T12:00:00Z"}{ "success": false, "error": "validation failed", "error_code": "VALIDATION_ERROR", "timestamp": "2026-06-15T12:00:00Z"}Create, edit, or delete a label PUT
Creates, renames, recolors, or deletes a label for the connected account via a WhatsApp app-state patch. Set deleted=true to remove the label.
Add a label to a message POST
Attaches a label to a specific message via a WhatsApp app-state patch. The chat_jid identifies the chat the message belongs to.