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

​
Descripción

Asigna una etiqueta existente a un chat. Si la etiqueta ya está presente en el chat, la operación se considera exitosa (idempotente). El cambio se propaga a WhatsApp vía app state.

​
Ejemplo

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"
  }'

​
Respuesta exitosa

La respuesta confirma la asignación devolviendo el tag_id aplicado. chat_jid no se incluye cuando el handler delega solo al servicio (campos omitempty); confía en success/message para el resultado de la operación.
200 OK
{
  "success": true,
  "message": "Tag assigned successfully",
  "tag_id": "2"
}

​
Parámetros de ruta

​
instance
string
requerido
Nombre de la instancia.

​
Cabeceras

NombreRequeridoEjemploDescripción
Content-Typesíapplication/json—
tokensí (o Authorization)a1b2c3d4-...TokenAccount o TokenInstance.

​
Cuerpo de la solicitud

​
number
string
requerido
Número de teléfono (5511999999999), JID privado (...@s.whatsapp.net o ...@lid), JID de grupo (...@g.us) o newsletter.
​
tagId
string
requerido
ID de la etiqueta a asignar.

​
Respuestas de error

HTTPerror.messageCuándo ocurre
400Instance name is required—
400Invalid request body: <...>JSON malformado.
400Number is required—
400tagId is required—
401Invalid token—
404Instance not found—
404Tag not foundEl tagId no existe.
503Instance is not connected to WhatsApp—
Error 404
{
  "success": false,
  "error": { "message": "Tag not found" }
}

​
Relacionados

Desasignar etiqueta

Quita la etiqueta del chat.

Contactos por etiqueta

Lista todos los chats que tienen la etiqueta.