> ## 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.

# Actualizar settings

> Actualiza los settings de comportamiento de la instancia

**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.

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST "https://ryzeapi.cloud/api/instance/settings/my-instance" \
    -H "token: $Token_Instance" \
    -H "Content-Type: application/json" \
    -d '{"autoReadMessages":true}'
  ```

  ```javascript JavaScript theme={null}
  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 })
  });
  ```

  ```python Python theme={null}
  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}
  )
  ```

  ```go Go theme={null}
  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)
  }
  ```
</CodeGroup>

### 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.

<CodeGroup>
  ```bash cURL theme={null}
  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."
    }'
  ```

  ```javascript JavaScript theme={null}
  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."
    })
  });
  ```

  ```python Python theme={null}
  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."
      }
  )
  ```

  ```go Go theme={null}
  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)
  }
  ```
</CodeGroup>

## Respuesta exitosa

La respuesta incluye **todos los 7 settings** (los no modificados vienen con su valor actual de la base de datos).

```json 200 OK theme={null}
{
  "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

<ParamField path="instance" type="string" required>
  Nombre de la instancia.
</ParamField>

## Cabeceras

<ParamField header="token" type="string" required>
  TokenAccount o TokenInstance.
</ParamField>

<ParamField header="Content-Type" type="string" required>
  `application/json`.
</ParamField>

## Cuerpo de la solicitud

<ParamField body="autoRejectCalls" type="boolean">
  Rechaza automáticamente las llamadas entrantes.
</ParamField>

<ParamField body="callRejectMessage" type="string">
  Mensaje automático al rechazar una llamada.
</ParamField>

<ParamField body="ignoreGroupMessages" type="boolean">
  No procesa mensajes recibidos en grupos.
</ParamField>

<ParamField body="keepOnlineStatus" type="boolean">
  Mantiene la presencia como `available`. Aplicado inmediatamente si la instancia está conectada.
</ParamField>

<ParamField body="autoReadMessages" type="boolean">
  Marca los mensajes recibidos como leídos.
</ParamField>

<ParamField body="disableHistorySync" type="boolean" default="true">
  Deshabilita la sincronización de historial en el primer `connect`. **Default `true`.**
</ParamField>

<ParamField body="ignoreStatus" type="boolean">
  Ignora mensajes de tipo "status" (stories) de WhatsApp.
</ParamField>

## Notas

<Warning>
  `disableHistorySync=true` en update **no elimina** el historial ya importado; solo afecta llamadas futuras a `connect`.
</Warning>

<Note>
  Aplicar `ignoreGroupMessages=true` **no** elimina los mensajes de grupo ya registrados; solo deja de registrar nuevos.
</Note>

## 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.    |

```json theme={null}
{
  "success": false,
  "error": {
    "message": "At least one setting must be provided"
  }
}
```
