Skip to main content
POST
Assign label
Auth: TokenAccount or TokenInstanceRate-limit: Global (100/min) • Idempotent: yes

Description

Assigns an existing label to a chat. If the label is already present on the chat, the operation is treated as success (idempotent). The change is propagated to WhatsApp via app state.

Example

Success response

The response confirms the assignment by echoing the applied tag_id. chat_jid is not included when the handler delegates only to the service (omitempty fields); rely on success/message for the operation result.
200 OK

Path parameters

string
required
Instance name.

Headers

Request body

string
required
Phone number (5511999999999), private JID (...@s.whatsapp.net or ...@lid), group JID (...@g.us), or newsletter.
string
required
ID of the label to assign.

Error responses

Error 404

Unassign label

Remove the label from the chat.

Contacts by label

List every chat that has the label.