Pular para o conteúdo principal
POST
/
api
/
chat
/
tag
/
:instance
Criar 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 ou TokenInstance • Rate-limit: Global (100/min) • Idempotente: não

​
Descrição

Cria uma etiqueta na instância. O id é alocado pela API (sequencial) e depois propagado ao WhatsApp via app state, pode levar 1 a 2 segundos para aparecer no celular.
color é opcional (default 0) e aceita um inteiro entre 0 e 10, que corresponde à paleta nativa do WhatsApp Business.

​
Exemplos

​
Mínimo

Cria a etiqueta apenas com name, sem cor. O servidor atribui color: 0 por padrão e gera um id sequencial retornado na resposta. 
curl -X POST "https://ryzeapi.cloud/api/chat/tag/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{"name":"Premium"}'

​
Com cor

Cria a etiqueta “VIP” usando o tom 5 da paleta do WhatsApp Business via color: 5 (faixa aceita: 0 a 10), permitindo diferenciar etiquetas visualmente no celular. 
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}'

​
Resposta de sucesso

O objeto tag traz o id gerado pelo WhatsApp (use-o em tags-atribuir/tags-desatribuir), o name salvo, a color aplicada (0 quando o cliente não enviou ou enviou fora da faixa 0–10) e o type da etiqueta. deleted permanece false em criações.
200 OK
{
  "success": true,
  "message": "Tag created successfully",
  "tag": {
    "id": "3",
    "name": "VIP",
    "color": 5,
    "type": "CUSTOM",
    "deleted": false
  }
}

​
Parâmetros de rota

​
instance
string
obrigatório
Nome da instância.

​
Headers

NomeObrigatórioExemploDescrição
Content-Typesimapplication/json—
tokensim (ou Authorization)a1b2c3d4-...TokenAccount ou TokenInstance.

​
Request body

​
name
string
obrigatório
Nome da etiqueta. Não pode estar vazio após TrimSpace.
​
color
int
padrão:"0"
Cor da etiqueta. Aceita inteiros entre 0 e 10, cada índice mapeia para uma cor da paleta nativa do WhatsApp Business:
colorHexCor
0#ff9485Vermelho coral
1#64c4ffAzul céu
2#ffd429Amarelo dourado
3#dfaef0Lilás claro
4#99b6c1Cinza azulado
5#55ccb3Verde menta
6#ff9dffRosa pink
7#d3a91dMostarda
8#6d7cceAzul violeta
9#d7e752Verde limão
10#00d0e2Ciano
Os valores acima refletem a paleta atual do WhatsApp Business (pode mudar em versões futuras do app, o índice é estável, o tom em si é definido pelo cliente WhatsApp). Valores fora da faixa 0–10 são silenciosamente normalizados para 0.

​
Respostas de erro

HTTPerror.messageQuando ocorre
400Instance name is required:instance vazio.
400Invalid request body: <...>JSON malformado.
400Tag name is requiredname vazio.
401Invalid token—
404Instance not found—
503Instance is not connected to WhatsApp—
Erro 400
{
  "success": false,
  "error": { "message": "Tag name is required" }
}

​
Relacionados

Listar etiquetas

Conferir o id recém-criado.

Atribuir a um chat

Aplicar a etiqueta após criar.