Pular para o conteúdo principal
DELETE
/
api
/
chat
/
assignTag
/
:instance
Desatribuir etiqueta
curl --request DELETE \
  --url https://api.example.com/api/chat/assignTag/: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 ou TokenInstance • Rate-limit: Global (100/min) • Idempotente: sim

​
Descrição

Remove uma etiqueta de um chat. Se o chat não possuir aquela etiqueta, a operação é considerada sucesso (idempotente). A etiqueta em si não é excluída, para excluir use Deletar etiqueta.

​
Exemplo

curl -X DELETE "https://ryzeapi.cloud/api/chat/assignTag/$Instance_Name?number=5511999999999&tagId=2" \
  -H "token: $Token_Instance"

​
Resposta de sucesso

A resposta confirma a remoção ecoando o tag_id. O envelope reusa o mesmo shape de tags-atribuir, apenas com message: "Tag removed successfully".
200 OK
{
  "success": true,
  "message": "Tag removed successfully",
  "tag_id": "2"
}

​
Parâmetros de rota

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

​
Query params

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

​
Headers

NomeObrigatórioExemploDescrição
tokensim (ou Authorization)a1b2c3d4-...TokenAccount ou TokenInstance.

​
Respostas de erro

HTTPerror.messageQuando ocorre
400Instance name is required—
400number query parameter is required—
400tagId query parameter is required—
401Invalid token—
404Instance not found—
404Tag not found—
503Instance is not connected to WhatsApp—
Erro 400
{
  "success": false,
  "error": { "message": "tagId query parameter is required" }
}

​
Relacionados

Atribuir etiqueta

Reatribuir a etiqueta a outro chat.

Deletar etiqueta

Excluir a etiqueta da instância inteira.