Unassign label

DELETE

api

chat

assignTag

:instance

Unassign label

curl --request DELETE \
  --url https://api.example.com/api/chat/assignTag/:instance

const options = {method: 'DELETE'};

fetch('https://api.example.com/api/chat/assignTag/:instance', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

Auth: TokenAccount or TokenInstance • Rate-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"

await fetch(`https://ryzeapi.cloud/api/chat/assignTag/${process.env.Instance_Name}?number=5511999999999&tagId=2`, {
  method: "DELETE",
  headers: {
    "token": process.env.Token_Instance
  }
});

import os, requests

requests.delete(
    f"https://ryzeapi.cloud/api/chat/assignTag/{os.environ['Instance_Name']}?number=5511999999999&tagId=2",
    headers={"token": os.environ["Token_Instance"]}
)

package main

import (
    "net/http"
    "os"
)

func main() {
    req, _ := http.NewRequest("DELETE", "https://ryzeapi.cloud/api/chat/assignTag/"+os.Getenv("Instance_Name")+"?number=5511999999999&tagId=2", nil)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    http.DefaultClient.Do(req)
}

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

string

required

Instance name.

Query params

string

required

Phone number, private JID (...@s.whatsapp.net or ...@lid), group JID (...@g.us), or newsletter.

string

required

ID of the label to remove.

Headers

Name	Required	Example	Description
`token`	yes (or `Authorization`)	`a1b2c3d4-...`	TokenAccount or TokenInstance.

Error responses

HTTP	`error.message`	When it happens
400	`Instance name is required`	,
400	`number query parameter is required`	,
400	`tagId query parameter is required`	,
401	`Invalid token`	,
404	`Instance not found`	,
404	`Tag not found`	,
503	`Instance 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.

Introduction

Instance

Events

Messages

Calls

Groups

Communities

Newsletter

Profile

Chat

Chatwoot

Typebot

Observability

Description

Example

Success response

Path parameters

Query params

Headers

Error responses

Assign label

Delete label

​Description

​Example

​Success response

​Path parameters

​Query params

​Headers

​Error responses

​Related

Assign label

Delete label

Description

Example

Success response

Path parameters

Query params

Headers

Error responses

Related