Pular para o conteúdo principal
POST
/
api
/
instance
/
settings
/
:instance
Definir Configurações
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 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. 
curl -X POST "https://ryzeapi.cloud/api/instance/settings/minha-instancia" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{"autoReadMessages":true}'

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

​
Resposta de sucesso

A resposta inclui todos os 7 settings (os não modificados vêm com o valor atual do banco).
200 OK
{
  "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

​
instance
string
obrigatório
Nome da instância.

​
Headers

​
token
string
obrigatório
TokenAccount ou TokenInstance.
​
Content-Type
string
obrigatório
application/json.

​
Request body

​
autoRejectCalls
boolean
Rejeita chamadas recebidas automaticamente.
​
callRejectMessage
string
Mensagem automática ao rejeitar chamada.
​
ignoreGroupMessages
boolean
Não processa mensagens recebidas em grupos.
​
keepOnlineStatus
boolean
Mantém presença available. Aplicado imediatamente se a instância estiver conectada.
​
autoReadMessages
boolean
Marca mensagens recebidas como lidas.
​
disableHistorySync
boolean
padrão:"true"
Desliga sincronização de histórico no primeiro connect. Default true.
​
ignoreStatus
boolean
Ignora mensagens tipo “status” (stories) do WhatsApp.

​
Notas

disableHistorySync=true no update não apaga histórico já importado, só afeta futuros connect.
Aplicar ignoreGroupMessages=true não apaga mensagens de grupos já gravadas; só para de gravar novas.

​
Erros

HTTPerror.messageQuando
400Invalid request bodyJSON malformado.
400At least one setting must be providedBody sem nenhum campo.
401Invalid tokenToken ausente ou inválido.
404Instance not foundNome não existe.
429Rate limit exceeded. Try again later.Mais de 100 req/min.
500Failed to update settings configurationErro de banco.
{
  "success": false,
  "error": {
    "message": "At least one setting must be provided"
  }
}