Saltar al contenido principal
GET
/
api
/
chat
/
tag
/
:instance
Listar etiquetas
curl --request GET \
  --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 o TokenInstance • Rate-limit: Global (100/min) • Idempotente: sí

​
Descripción

Devuelve todas las etiquetas conocidas por la instancia, incluyendo las creadas vía API y las importadas desde el app state de WhatsApp. Cada etiqueta lleva un id, name, color (paleta nativa de WhatsApp), type y bandera deleted.
color es un entero entre 0 y 10 que mapea a los colores oficiales de WhatsApp Business. Las etiquetas marcadas con deleted=true siguen apareciendo en la lista hasta que la sincronización las elimine definitivamente.

​
Ejemplo

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

​
Respuesta exitosa

tags es el array de etiquetas conocidas por la cuenta de WhatsApp Business; total repite el tamaño. Cada entrada lleva id (úsalo en tags-assign/tags-unassign/tags-delete), name, color (0–10) y type. Las etiquetas marcadas con deleted: true representan eliminaciones pendientes de propagación.
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
}

​
Parámetros de ruta

​
instance
string
requerido
Nombre de la instancia.

​
Cabeceras

NombreRequeridoEjemploDescripción
tokensí (o Authorization)a1b2c3d4-...TokenAccount o TokenInstance.

​
Respuestas de error

HTTPerror.messageCuándo ocurre
400Instance name is required:instance vacío.
401Invalid token—
404Instance not found—
503Instance is not connected to WhatsApp—
Error 401
{
  "success": false,
  "error": { "message": "Invalid token" }
}

​
Relacionados

Crear etiqueta

POST /api/chat/tag/:instance

Asignar a un chat

POST /api/chat/assignTag/:instance