GET

https://{server-url}

/
settings
/
find
/
{instance}
curl --request GET \
  --url https://{server-url}/settings/find/{instance} \
  --header 'apikey: <api-key>'
{
  "reject_call": true,
  "groups_ignore": true,
  "always_online": true,
  "read_messages": true,
  "read_status": true,
  "sync_full_history": false
}

Authorizations

apikey
string
headerrequired

Your authorization key header

Path Parameters

instance
string
required

ID of the instance to connect

Response

200 - application/json
reject_call
boolean

Indicates whether to reject incoming calls.

groups_ignore
boolean

Indicates whether to ignore group messages.

always_online
boolean

Indicates whether to always keep the instance online.

read_messages
boolean

Indicates whether to mark messages as read.

read_status
boolean

Indicates whether to read status updates.

sync_full_history
boolean

Indicates whether to synchronize full message history.