Actualizar settings

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

const options = {
  method: 'POST',
  headers: {token: '<token>', 'Content-Type': '<content-type>'},
  body: JSON.stringify({
    autoRejectCalls: true,
    callRejectMessage: '<string>',
    ignoreGroupMessages: true,
    keepOnlineStatus: true,
    autoReadMessages: true,
    disableHistorySync: true,
    ignoreStatus: true
  })
};

fetch('https://api.example.com/api/instance/settings/:instance', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/api/instance/settings/:instance"

payload = {
    "autoRejectCalls": True,
    "callRejectMessage": "<string>",
    "ignoreGroupMessages": True,
    "keepOnlineStatus": True,
    "autoReadMessages": True,
    "disableHistorySync": True,
    "ignoreStatus": True
}
headers = {
    "token": "<token>",
    "Content-Type": "<content-type>"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

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

await fetch("https://ryzeapi.cloud/api/instance/settings/my-instance", {
  method: "POST",
  headers: {
    "token":        process.env.Token_Instance,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({ autoReadMessages: true })
});

import os, requests

requests.post(
    "https://ryzeapi.cloud/api/instance/settings/my-instance",
    headers={
        "token":        os.environ["Token_Instance"],
        "Content-Type": "application/json"
    },
    json={"autoReadMessages": True}
)

package main

import (
    "net/http"
    "os"
    "strings"
)

func main() {
    body := strings.NewReader(`{"autoReadMessages":true}`)
    req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/instance/settings/my-instance", body)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    req.Header.Set("Content-Type", "application/json")
    http.DefaultClient.Do(req)
}

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

await fetch("https://ryzeapi.cloud/api/instance/settings/my-instance", {
  method: "POST",
  headers: {
    "token":        process.env.Token_Instance,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    ignoreGroupMessages: true,
    ignoreStatus:        true,
    autoRejectCalls:     true,
    callRejectMessage:   "I do not take calls here."
  })
});

import os, requests

requests.post(
    "https://ryzeapi.cloud/api/instance/settings/my-instance",
    headers={
        "token":        os.environ["Token_Instance"],
        "Content-Type": "application/json"
    },
    json={
        "ignoreGroupMessages": True,
        "ignoreStatus":        True,
        "autoRejectCalls":     True,
        "callRejectMessage":   "I do not take calls here."
    }
)

package main

import (
    "net/http"
    "os"
    "strings"
)

func main() {
    body := strings.NewReader(`{
        "ignoreGroupMessages": true,
        "ignoreStatus":        true,
        "autoRejectCalls":     true,
        "callRejectMessage":   "I do not take calls here."
    }`)
    req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/instance/settings/my-instance", body)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    req.Header.Set("Content-Type", "application/json")
    http.DefaultClient.Do(req)
}

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

string

requerido

Nombre de la instancia.

Cabeceras

string

requerido

TokenAccount o TokenInstance.

string

requerido

application/json.

Cuerpo de la solicitud

boolean

Rechaza automáticamente las llamadas entrantes.

string

Mensaje automático al rechazar una llamada.

boolean

No procesa mensajes recibidos en grupos.

boolean

Mantiene la presencia como available. Aplicado inmediatamente si la instancia está conectada.

boolean

Marca los mensajes recibidos como leídos.

boolean

predeterminado:"true"

Deshabilita la sincronización de historial en el primer connect. Default true.

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

HTTP	`error.message`	Cuándo
400	`Invalid request body`	JSON malformado.
400	`At least one setting must be provided`	Body sin ningún campo.
401	`Invalid token`	Token faltante o inválido.
404	`Instance not found`	Nombre no existe.
429	`Rate limit exceeded. Try again later.`	Más de 100 req/min.
500	`Failed to update settings configuration`	Error de base de datos.

{
  "success": false,
  "error": {
    "message": "At least one setting must be provided"
  }
}

Introducción

Instancia

Eventos

Mensajes

Llamadas

Grupos

Comunidades

Newsletter

Perfil

Chat

Chatwoot

Typebot

Observabilidad

Actualizar settings

Descripción

Ejemplos

Cambiar solo autoReadMessages

Combo anti-ruido

Respuesta exitosa

Parámetros de ruta

Cabeceras

Cuerpo de la solicitud

Notas

Errores

​Descripción

​Ejemplos

​Cambiar solo autoReadMessages

​Combo anti-ruido

​Respuesta exitosa

​Parámetros de ruta

​Cabeceras

​Cuerpo de la solicitud

​Notas

​Errores

Descripción

Ejemplos

Cambiar solo autoReadMessages

Combo anti-ruido

Respuesta exitosa

Parámetros de ruta

Cabeceras

Cuerpo de la solicitud

Notas

Errores