Skip to main content
DELETE
/
api
/
chat
/
assignTag
/
:instance
Unassign label
curl --request DELETE \
  --url https://api.example.com/api/chat/assignTag/:instance

Documentation Index

Fetch the complete documentation index at: https://docs.ryzeapi.cloud/llms.txt

Use this file to discover all available pages before exploring further.

Auth: TokenAccount or TokenInstanceRate-limit: Global (100/min) • Idempotent: yes

Description

Removes one label from a chat. If the chat does not have that label, the operation is considered a success (idempotent). The label itself is not deleted, to delete it, use Delete label.

Example

curl -X DELETE "https://ryzeapi.cloud/api/chat/assignTag/$Instance_Name?number=5511999999999&tagId=2" \
  -H "token: $Token_Instance"

Success response

The response confirms the removal by echoing the tag_id. The envelope reuses the same shape as tags-assign, only with message: "Tag removed successfully".
200 OK
{
  "success": true,
  "message": "Tag removed successfully",
  "tag_id": "2"
}

Path parameters

instance
string
required
Instance name.

Query params

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

Headers

NameRequiredExampleDescription
tokenyes (or Authorization)a1b2c3d4-...TokenAccount or TokenInstance.

Error responses

HTTPerror.messageWhen it happens
400Instance name is required
400number query parameter is required
400tagId query parameter is required
401Invalid token
404Instance not found
404Tag not found
503Instance is not connected to WhatsApp
Error 400
{
  "success": false,
  "error": { "message": "tagId query parameter is required" }
}

Assign label

Reassign the label to another chat.

Delete label

Remove the label from the entire instance.