Labels

Create, edit, or delete a label

Creates, renames, recolors, or deletes a label for the connected account via a WhatsApp app-state patch. Set deleted=true to remove the label.

PUT
/labels/{labelId}

Creates, renames, recolors, or deletes a label for the connected account via a WhatsApp app-state patch. Set deleted=true to remove the label.

Authorization

bearerAuth
AuthorizationBearer <token>

Per-user API token (UUID v4) sent as Authorization: Bearer <token>. Identifies the tenant and user.

In: header

Path Parameters

labelId*string

Identifier of the label to create or edit.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Payload for creating, editing, or deleting a label.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PUT "https://example.com/labels/1" \  -H "Content-Type: application/json" \  -d '{    "name": "Clientes VIP",    "color": 5,    "deleted": false  }'
{  "success": true,  "label_id": "1",  "name": "Clientes VIP",  "color": 5,  "deleted": false}
{  "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"}

Set the account profile picture POST

Updates the connected WhatsApp account's own profile photo. The image must be a base64-encoded JPEG; it replaces the current picture and returns the new picture ID.

Add a label to a chat POST

Attaches an existing label to a chat for the connected account via a WhatsApp app-state patch.