Skip to main content
POST
/
api
/
instance
/
settings
/
:instance
Update 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 or TokenInstance • Rate-limit: Global (100/min) • Idempotent: yes

​
Description

Accepts a partial body, fields not sent are kept. At least one field must be informed. If keepOnlineStatus is sent and the instance is connected, presence is applied in real time (sends PresenceAvailable or PresenceUnavailable).

​
Examples

​
Change only autoReadMessages

Partial body with only autoReadMessages: true, the other 6 settings are untouched, the server only updates the field sent and returns the full object in the response. 
curl -X POST "https://ryzeapi.cloud/api/instance/settings/my-instance" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{"autoReadMessages":true}'

​
Anti-noise combo

Applies four settings at once to silence the number: ignores group messages, ignores stories, rejects calls, and replies to the caller with the callRejectMessage. Typical combination for 1-to-1 bots that don’t want to be interrupted. 
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."
  }'

​
Success response

The response includes all 7 settings (those not modified come with their current value from the database).
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
  }
}

​
Path parameters

​
instance
string
required
Instance name.

​
Headers

​
token
string
required
TokenAccount or TokenInstance.
​
Content-Type
string
required
application/json.

​
Request body

​
autoRejectCalls
boolean
Automatically rejects incoming calls.
​
callRejectMessage
string
Automatic message when rejecting a call.
​
ignoreGroupMessages
boolean
Does not process messages received in groups.
​
keepOnlineStatus
boolean
Keeps presence as available. Applied immediately if the instance is connected.
​
autoReadMessages
boolean
Marks received messages as read.
​
disableHistorySync
boolean
default:"true"
Disables history synchronization on the first connect. Default true.
​
ignoreStatus
boolean
Ignores “status” type messages (stories) from WhatsApp.

​
Notes

disableHistorySync=true on update does not delete already imported history; it only affects future connect calls.
Applying ignoreGroupMessages=true does not delete already recorded group messages; it just stops recording new ones.

​
Errors

HTTPerror.messageWhen
400Invalid request bodyMalformed JSON.
400At least one setting must be providedBody without any field.
401Invalid tokenToken missing or invalid.
404Instance not foundName does not exist.
429Rate limit exceeded. Try again later.More than 100 req/min.
500Failed to update settings configurationDatabase error.
{
  "success": false,
  "error": {
    "message": "At least one setting must be provided"
  }
}