Pular para o conteúdo principal
POST
/
api
/
chat
/
assignTag
/
:instance
Atribuir etiqueta
curl --request POST \
  --url https://api.example.com/api/chat/assignTag/:instance \
  --header 'Content-Type: application/json' \
  --data '
{
  "number": "<string>",
  "tagId": "<string>"
}
'

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

​
Descrição

Atribui uma etiqueta existente a um chat. Se a etiqueta já estiver presente no chat, a operação é tratada como sucesso (idempotente). A mudança é propagada ao WhatsApp via app state.

​
Exemplo

curl -X POST "https://ryzeapi.cloud/api/chat/assignTag/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "number": "5511999999999",
    "tagId":  "2"
  }'

​
Resposta de sucesso

A resposta confirma a atribuição ecoando o tag_id aplicado. O chat_jid não é incluído quando o handler delega apenas para o serviço (campos omitempty); confie em success/message para o resultado da operação.
200 OK
{
  "success": true,
  "message": "Tag assigned successfully",
  "tag_id": "2"
}

​
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

​
number
string
obrigatório
Telefone (5511999999999), JID privado (...@s.whatsapp.net ou ...@lid), JID de grupo (...@g.us) ou newsletter.
​
tagId
string
obrigatório
ID da etiqueta a atribuir.

​
Respostas de erro

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

​
Relacionados

Desatribuir etiqueta

Remover a etiqueta do chat.

Contatos por etiqueta

Listar todos os chats com a etiqueta.