Saltar al contenido principal
POST
/
api
/
chat
/
pin
/
:instance
Fijar chat
curl --request POST \
  --url https://api.example.com/api/chat/pin/:instance \
  --header 'Content-Type: application/json' \
  --data '
{
  "number": "<string>",
  "pin": true
}
'

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

Marca un chat como fijado (pin: true) o quita el fijado (pin: false).
WhatsApp limita a 3 chats fijados simultáneamente. Intentar fijar un cuarto devuelve un error de WhatsMeow propagado a la respuesta.

​
Ejemplos

​
Fijar

Con pin: true, el chat se mueve al inicio de la lista. Recuerda que WhatsApp permite como máximo 3 chats fijados al mismo tiempo, intentar un cuarto devuelve un error. 
curl -X POST "https://ryzeapi.cloud/api/chat/pin/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "number": "5511999999999",
    "pin":    true
  }'

​
Desfijar

Con pin: false, quita el fijado y el chat regresa al orden normal por actividad. Libera un slot del límite de 3 chats fijados. 
curl -X POST "https://ryzeapi.cloud/api/chat/pin/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "number": "5511999999999",
    "pin":    false
  }'

​
Respuesta exitosa

La respuesta confirma la operación con chat_jid (JID resuelto desde number) y pinned reflejando el estado final. El message cambia según el valor de pin: "Chat pinned successfully" o "Chat unpinned successfully".
200 OK
{
  "success": true,
  "message": "Chat pinned successfully",
  "chat_jid": "5511999999999@s.whatsapp.net",
  "pinned": true
}

​
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, JID privado (...@s.whatsapp.net o ...@lid), JID de grupo (...@g.us) o newsletter.
​
pin
boolean
requerido
true fija, false desfija.

​
Respuestas de error

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

​
Relacionados

Archivar chat

POST /api/chat/archive/:instance

Favorito

POST /api/chat/favorite/:instance