Saltar al contenido principal
POST
/
api
/
instance
/
settings
/
:instance
Actualizar settings
curl --request POST \
  --url https://api.example.com/api/instance/settings/:instance \
  --header 'Content-Type: <content-type>' \
  --header 'token: <token>' \
  --data '
{
  "autoRejectCalls": true,
  "callRejectMessage": "<string>",
  "ignoreGroupMessages": true,
  "keepOnlineStatus": true,
  "autoReadMessages": true,
  "disableHistorySync": true,
  "ignoreStatus": 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

Acepta un body parcial, los campos no enviados se mantienen. Al menos un campo debe ser informado. Si keepOnlineStatus se envía y la instancia está conectada, la presencia se aplica en tiempo real (envía PresenceAvailable o PresenceUnavailable).

​
Ejemplos

​
Cambiar solo autoReadMessages

Body parcial con solo autoReadMessages: true, los otros 6 settings quedan intactos, el servidor solo actualiza el campo enviado y devuelve el objeto completo en la respuesta. 
curl -X POST "https://ryzeapi.cloud/api/instance/settings/my-instance" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{"autoReadMessages":true}'

​
Combo anti-ruido

Aplica cuatro settings a la vez para silenciar el número: ignora mensajes de grupo, ignora estados, rechaza llamadas y responde al llamante con el callRejectMessage. Combinación típica para bots 1-a-1 que no quieren ser interrumpidos. 
curl -X POST "https://ryzeapi.cloud/api/instance/settings/my-instance" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "ignoreGroupMessages": true,
    "ignoreStatus": true,
    "autoRejectCalls": true,
    "callRejectMessage": "I do not take calls here."
  }'

​
Respuesta exitosa

La respuesta incluye todos los 7 settings (los no modificados vienen con su valor actual de la base de datos).
200 OK
{
  "success": true,
  "message": "Settings updated successfully",
  "settings": {
    "autoRejectCalls": true,
    "callRejectMessage": "I do not take calls here.",
    "ignoreGroupMessages": true,
    "keepOnlineStatus": false,
    "autoReadMessages": false,
    "disableHistorySync": true,
    "ignoreStatus": true
  }
}

​
Parámetros de ruta

​
instance
string
requerido
Nombre de la instancia.

​
Cabeceras

​
token
string
requerido
TokenAccount o TokenInstance.
​
Content-Type
string
requerido
application/json.

​
Cuerpo de la solicitud

​
autoRejectCalls
boolean
Rechaza automáticamente las llamadas entrantes.
​
callRejectMessage
string
Mensaje automático al rechazar una llamada.
​
ignoreGroupMessages
boolean
No procesa mensajes recibidos en grupos.
​
keepOnlineStatus
boolean
Mantiene la presencia como available. Aplicado inmediatamente si la instancia está conectada.
​
autoReadMessages
boolean
Marca los mensajes recibidos como leídos.
​
disableHistorySync
boolean
predeterminado:"true"
Deshabilita la sincronización de historial en el primer connect. Default true.
​
ignoreStatus
boolean
Ignora mensajes de tipo “status” (stories) de WhatsApp.

​
Notas

disableHistorySync=true en update no elimina el historial ya importado; solo afecta llamadas futuras a connect.
Aplicar ignoreGroupMessages=true no elimina los mensajes de grupo ya registrados; solo deja de registrar nuevos.

​
Errores

HTTPerror.messageCuándo
400Invalid request bodyJSON malformado.
400At least one setting must be providedBody sin ningún campo.
401Invalid tokenToken faltante o inválido.
404Instance not foundNombre no existe.
429Rate limit exceeded. Try again later.Más de 100 req/min.
500Failed to update settings configurationError de base de datos.
{
  "success": false,
  "error": {
    "message": "At least one setting must be provided"
  }
}