Saltar al contenido principal
DELETE
/
api
/
chat
/
tag
/
:instance
Eliminar 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 o TokenInstance • Rate-limit: Global (100/min) • Idempotente: sí

​
Descripción

Elimina la etiqueta identificada por tagId y la desasigna automáticamente de cada chat que la tenía. La propagación a WhatsApp vía app state puede tardar 1 a 2 segundos.

​
Ejemplo

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

​
Respuesta exitosa

El envoltorio devuelve tag que contiene solo el id removido y deleted: true, los demás campos (name, color, type) vienen vacíos porque la etiqueta ya no existe. Usa success para auditar la operación.
200 OK
{
  "success": true,
  "message": "Tag deleted successfully",
  "tag": {
    "id": "3",
    "name": "",
    "color": 0,
    "type": "",
    "deleted": true
  }
}

​
Parámetros de ruta

​
instance
string
requerido
Nombre de la instancia.

​
Parámetros de consulta

​
tagId
string
requerido
ID de la etiqueta a eliminar.

​
Cabeceras

NombreRequeridoEjemploDescripción
tokensí (o Authorization)a1b2c3d4-...TokenAccount o TokenInstance.

​
Respuestas de error

HTTPerror.messageCuándo ocurre
400Instance name is required:instance vacío.
400tagId query parameter is requiredFalta tagId.
401Invalid token—
404Instance not found—
404Tag not found—
503Instance is not connected to WhatsApp—
Error 400
{
  "success": false,
  "error": { "message": "tagId query parameter is required" }
}

​
Relacionados

Listar etiquetas

Verifica los IDs disponibles.

Desasignar etiqueta

Quita la etiqueta de un chat específico en lugar de eliminarla.