Skip to main content
DELETE
/
api
/
chat
/
tag
/
:instance
Delete label
curl --request DELETE \
  --url https://api.example.com/api/chat/tag/: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 TokenInstance • Rate-limit: Global (100/min) • Idempotent: yes

​
Description

Removes the label identified by tagId and automatically unassigns it from every chat that had it. Propagation to WhatsApp via app state may take 1 to 2 seconds.

​
Example

curl -X DELETE "https://ryzeapi.cloud/api/chat/tag/$Instance_Name?tagId=3" \
  -H "token: $Token_Instance"

​
Success response

The envelope returns tag containing only the removed id and deleted: true, the other fields (name, color, type) come empty because the label no longer exists. Use success to audit the operation.
200 OK
{
  "success": true,
  "message": "Tag deleted successfully",
  "tag": {
    "id": "3",
    "name": "",
    "color": 0,
    "type": "",
    "deleted": true
  }
}

​
Path parameters

​
instance
string
required
Instance name.

​
Query params

​
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 requiredEmpty :instance.
400tagId query parameter is requiredMissing tagId.
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" }
}

List labels

Check available IDs.

Unassign label

Remove the label from a specific chat instead of deleting it.