Skip to main content
GET
/
api
/
instance
/
getSettings
/
:instance
Read Settings
curl --request GET \
  --url https://api.example.com/api/instance/getSettings/:instance \
  --header 'token: <token>'

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

Returns the 7 instance behavior flags: call rejection, ignore groups, keep online, mark as read, history sync, ignore status.

​
Example

Performs a GET on the instance path and returns the settings object with all current flags. No query params are accepted, only the name in the path and the token in the header. 
curl -X GET "https://ryzeapi.cloud/api/instance/getSettings/my-instance" \
  -H "token: $Token_Instance"

​
Success response

200 OK
{
  "success": true,
  "message": "Settings retrieved successfully",
  "settings": {
    "autoRejectCalls": false,
    "callRejectMessage": "",
    "ignoreGroupMessages": false,
    "keepOnlineStatus": false,
    "autoReadMessages": false,
    "disableHistorySync": true,
    "ignoreStatus": false
  }
}

​
Path parameters

​
instance
string
required
Instance name.

​
Headers

​
token
string
required
TokenAccount or TokenInstance.

​
Fields

FieldTypeDescription
autoRejectCallsbooleanAutomatically rejects calls
callRejectMessagestringMessage sent when rejecting
ignoreGroupMessagesbooleanIgnores group events on ingestion
keepOnlineStatusbooleanKeeps presence as available
autoReadMessagesbooleanMarks received messages as read
disableHistorySyncbooleanDisables history sync (default true)
ignoreStatusbooleanIgnores “status” type messages (stories)

​
Errors

HTTPerror.messageWhen
401Invalid tokenToken missing or invalid.
404Instance not foundName does not exist.
429Rate limit exceeded. Try again later.More than 100 req/min.
500Failed to get settings configurationDatabase error.
{
  "success": false,
  "error": {
    "message": "Instance not found"
  }
}

​
Next

Update settings

POST /api/instance/settings/:instance to change.