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

​
Descrição

Remove a etiqueta identificada por tagId e também desatribui automaticamente de todos os chats que a possuíam. A propagação até o WhatsApp via app state pode levar 1 a 2 segundos.

​
Exemplo

curl -X DELETE "https://ryzeapi.cloud/api/chat/tag/$Instance_Name?tagId=3" \
  -H "token: $Token_Instance"

​
Resposta de sucesso

O envelope vem com tag contendo apenas o id removido e deleted: true, os demais campos (name, color, type) ficam vazios pois a etiqueta já não existe mais. Use success para auditar a operação.
200 OK
{
  "success": true,
  "message": "Tag deleted successfully",
  "tag": {
    "id": "3",
    "name": "",
    "color": 0,
    "type": "",
    "deleted": true
  }
}

​
Parâmetros de rota

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

​
Query params

​
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:instance vazio.
400tagId query parameter is requiredtagId ausente.
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

Listar etiquetas

Conferir os IDs disponíveis.

Desatribuir etiqueta

Remover a etiqueta de um chat específico em vez de excluir.