List labels

GET

api

chat

tag

:instance

List labels

curl --request GET \
  --url https://api.example.com/api/chat/tag/:instance

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

Description

Returns every label known to the instance, including those created via API and those imported through WhatsApp app state. Each label carries an id, name, color (native WhatsApp palette), type, and deleted flag.

color is an integer between 0 and 10 that maps to the official WhatsApp Business colors. Tags marked with deleted=true still appear in the list until the sync removes them for good.

Example

curl -X GET "https://ryzeapi.cloud/api/chat/tag/$Instance_Name" \
  -H "token: $Token_Instance"

await fetch(`https://ryzeapi.cloud/api/chat/tag/${process.env.Instance_Name}`, {
  method: "GET",
  headers: {
    "token": process.env.Token_Instance
  }
});

import os, requests

requests.get(
    f"https://ryzeapi.cloud/api/chat/tag/{os.environ['Instance_Name']}",
    headers={"token": os.environ["Token_Instance"]}
)

package main

import (
    "net/http"
    "os"
)

func main() {
    req, _ := http.NewRequest("GET", "https://ryzeapi.cloud/api/chat/tag/"+os.Getenv("Instance_Name"), nil)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    http.DefaultClient.Do(req)
}

Success response

tags is the array of labels known to the WhatsApp Business account; total echoes the size. Each entry brings id (use in tags-assign/tags-unassign/tags-delete), name, color (0–10), and type. Labels marked with deleted: true represent removals pending propagation.

200 OK

{
  "success": true,
  "message": "Tags retrieved successfully",
  "tags": [
    { "id": "1", "name": "Important", "color": 0, "type": "CUSTOM", "deleted": false },
    { "id": "2", "name": "VIP", "color": 5, "type": "CUSTOM", "deleted": false }
  ],
  "total": 2
}

Path parameters

string

required

Instance name.

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`	Empty `:instance`.
401	`Invalid token`	,
404	`Instance not found`	,
503	`Instance is not connected to WhatsApp`	,

Error 401

{
  "success": false,
  "error": { "message": "Invalid token" }
}

Create label

POST /api/chat/tag/:instance

Assign to a chat

POST /api/chat/assignTag/:instance

Introduction

Instance

Events

Messages

Calls

Groups

Communities

Newsletter

Profile

Chat

Chatwoot

Typebot

Observability

Description

Example

Success response

Path parameters

Headers

Error responses

Create label

Assign to a chat

​Description

​Example

​Success response

​Path parameters

​Headers

​Error responses

​Related

Create label

Assign to a chat

Description

Example

Success response

Path parameters

Headers

Error responses

Related