Saltar al contenido principal
POST
/
api
/
chat
/
tag
/
:instance
Crear etiqueta
curl --request POST \
  --url https://api.example.com/api/chat/tag/:instance \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "color": 123
}
'

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: no

​
Descripción

Crea una etiqueta en la instancia. El id lo asigna la API (secuencial) y luego se propaga a WhatsApp vía app state, puede tardar 1 a 2 segundos en aparecer en el teléfono.
color es opcional (predeterminado 0) y acepta un entero entre 0 y 10, que corresponde a la paleta nativa de WhatsApp Business.

​
Ejemplos

​
Mínimo

Crea la etiqueta solo con name, sin color. El servidor asigna color: 0 por defecto y genera un id secuencial devuelto en la respuesta. 
curl -X POST "https://ryzeapi.cloud/api/chat/tag/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{"name":"Premium"}'

​
Con color

Crea la etiqueta “VIP” usando el tono 5 de la paleta de WhatsApp Business vía color: 5 (rango aceptado: 0 a 10), permitiendo diferenciar visualmente etiquetas en el teléfono. 
curl -X POST "https://ryzeapi.cloud/api/chat/tag/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{"name":"VIP","color":5}'

​
Respuesta exitosa

El objeto tag lleva el id generado por WhatsApp (úsalo en tags-assign/tags-unassign), el name guardado, el color aplicado (0 cuando el cliente no lo envió o lo envió fuera del rango 0–10) y el type de la etiqueta. deleted se mantiene en false en las creaciones.
200 OK
{
  "success": true,
  "message": "Tag created successfully",
  "tag": {
    "id": "3",
    "name": "VIP",
    "color": 5,
    "type": "CUSTOM",
    "deleted": false
  }
}

​
Parámetros de ruta

​
instance
string
requerido
Nombre de la instancia.

​
Cabeceras

NombreRequeridoEjemploDescripción
Content-Typesíapplication/json—
tokensí (o Authorization)a1b2c3d4-...TokenAccount o TokenInstance.

​
Cuerpo de la solicitud

​
name
string
requerido
Nombre de la etiqueta. No puede estar vacío después de TrimSpace.
​
color
int
predeterminado:"0"
Color de la etiqueta. Acepta enteros entre 0 y 10, cada índice mapea a un color de la paleta nativa de WhatsApp Business:
colorHexColor
0#ff9485Rojo coral
1#64c4ffAzul cielo
2#ffd429Amarillo dorado
3#dfaef0Lila claro
4#99b6c1Gris azulado
5#55ccb3Verde menta
6#ff9dffRosa
7#d3a91dMostaza
8#6d7cceAzul violeta
9#d7e752Verde lima
10#00d0e2Cian
Los valores anteriores reflejan la paleta actual de WhatsApp Business (puede cambiar en futuras versiones de la app, el índice es estable, el tono concreto lo define el cliente de WhatsApp). Los valores fuera del rango 0–10 se normalizan silenciosamente a 0.

​
Respuestas de error

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

​
Relacionados

Listar etiquetas

Confirma el id recién creado.

Asignar a un chat

Aplica la etiqueta tras crearla.