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

# Definir Configurações

> Atualiza configurações de comportamento da instância

**Auth:** `TokenAccount` ou `TokenInstance` • **Rate-limit:** `Global` (100/min) • **Idempotente:** sim

## Descrição

Aceita **body parcial**, campos não enviados são mantidos. Pelo menos um campo precisa ser informado.

Se `keepOnlineStatus` é enviado **e** a instância está conectada, a presença é aplicada em tempo real (envia `PresenceAvailable` ou `PresenceUnavailable`).

## Exemplos

### Alterar só autoReadMessages

Body parcial com apenas `autoReadMessages: true`, os outros 6 settings ficam intocados, o servidor só atualiza o campo enviado e devolve o objeto completo na resposta.

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

  ```javascript JavaScript theme={null}
  await fetch("https://ryzeapi.cloud/api/instance/settings/minha-instancia", {
    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/minha-instancia",
      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/minha-instancia", body)
      req.Header.Set("token", os.Getenv("Token_Instance"))
      req.Header.Set("Content-Type", "application/json")
      http.DefaultClient.Do(req)
  }
  ```
</CodeGroup>

### Combo anti-ruído

Aplica de uma vez quatro settings para silenciar o número: ignora mensagens de grupo, ignora stories, rejeita chamadas e responde ao chamador com a `callRejectMessage`. Combinação típica para bots 1-a-1 que não querem ser interrompidos.

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST "https://ryzeapi.cloud/api/instance/settings/minha-instancia" \
    -H "token: $Token_Instance" \
    -H "Content-Type: application/json" \
    -d '{
      "ignoreGroupMessages": true,
      "ignoreStatus": true,
      "autoRejectCalls": true,
      "callRejectMessage": "Não atendo ligações por aqui."
    }'
  ```

  ```javascript JavaScript theme={null}
  await fetch("https://ryzeapi.cloud/api/instance/settings/minha-instancia", {
    method: "POST",
    headers: {
      "token":        process.env.Token_Instance,
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      ignoreGroupMessages: true,
      ignoreStatus:        true,
      autoRejectCalls:     true,
      callRejectMessage:   "Não atendo ligações por aqui."
    })
  });
  ```

  ```python Python theme={null}
  import os, requests

  requests.post(
      "https://ryzeapi.cloud/api/instance/settings/minha-instancia",
      headers={
          "token":        os.environ["Token_Instance"],
          "Content-Type": "application/json"
      },
      json={
          "ignoreGroupMessages": True,
          "ignoreStatus":        True,
          "autoRejectCalls":     True,
          "callRejectMessage":   "Não atendo ligações por aqui."
      }
  )
  ```

  ```go Go theme={null}
  package main

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

  func main() {
      body := strings.NewReader(`{
          "ignoreGroupMessages": true,
          "ignoreStatus":        true,
          "autoRejectCalls":     true,
          "callRejectMessage":   "Não atendo ligações por aqui."
      }`)
      req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/instance/settings/minha-instancia", body)
      req.Header.Set("token", os.Getenv("Token_Instance"))
      req.Header.Set("Content-Type", "application/json")
      http.DefaultClient.Do(req)
  }
  ```
</CodeGroup>

## Resposta de sucesso

A resposta inclui **todos os 7 settings** (os não modificados vêm com o valor atual do banco).

```json 200 OK theme={null}
{
  "success": true,
  "message": "Settings updated successfully",
  "settings": {
    "autoRejectCalls": true,
    "callRejectMessage": "Não atendo ligações por aqui.",
    "ignoreGroupMessages": true,
    "keepOnlineStatus": false,
    "autoReadMessages": false,
    "disableHistorySync": true,
    "ignoreStatus": true
  }
}
```

## Path parameters

<ParamField path="instance" type="string" required>
  Nome da instância.
</ParamField>

## Headers

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

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

## Request body

<ParamField body="autoRejectCalls" type="boolean">
  Rejeita chamadas recebidas automaticamente.
</ParamField>

<ParamField body="callRejectMessage" type="string">
  Mensagem automática ao rejeitar chamada.
</ParamField>

<ParamField body="ignoreGroupMessages" type="boolean">
  Não processa mensagens recebidas em grupos.
</ParamField>

<ParamField body="keepOnlineStatus" type="boolean">
  Mantém presença `available`. Aplicado imediatamente se a instância estiver conectada.
</ParamField>

<ParamField body="autoReadMessages" type="boolean">
  Marca mensagens recebidas como lidas.
</ParamField>

<ParamField body="disableHistorySync" type="boolean" default="true">
  Desliga sincronização de histórico no primeiro `connect`. **Default `true`.**
</ParamField>

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

## Notas

<Warning>
  `disableHistorySync=true` no update **não apaga** histórico já importado, só afeta futuros `connect`.
</Warning>

<Note>
  Aplicar `ignoreGroupMessages=true` **não** apaga mensagens de grupos já gravadas; só para de gravar novas.
</Note>

## Erros

| HTTP | `error.message`                           | Quando                     |
| :--: | ----------------------------------------- | -------------------------- |
|  400 | `Invalid request body`                    | JSON malformado.           |
|  400 | `At least one setting must be provided`   | Body sem nenhum campo.     |
|  401 | `Invalid token`                           | Token ausente ou inválido. |
|  404 | `Instance not found`                      | Nome não existe.           |
|  429 | `Rate limit exceeded. Try again later.`   | Mais de 100 req/min.       |
|  500 | `Failed to update settings configuration` | Erro de banco.             |

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