Update Settings

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
}
'

const options = {
  method: 'POST',
  headers: {token: '<token>', 'Content-Type': '<content-type>'},
  body: JSON.stringify({
    autoRejectCalls: true,
    callRejectMessage: '<string>',
    ignoreGroupMessages: true,
    keepOnlineStatus: true,
    autoReadMessages: true,
    disableHistorySync: true,
    ignoreStatus: true
  })
};

fetch('https://api.example.com/api/instance/settings/:instance', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/api/instance/settings/:instance"

payload = {
    "autoRejectCalls": True,
    "callRejectMessage": "<string>",
    "ignoreGroupMessages": True,
    "keepOnlineStatus": True,
    "autoReadMessages": True,
    "disableHistorySync": True,
    "ignoreStatus": True
}
headers = {
    "token": "<token>",
    "Content-Type": "<content-type>"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

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}'

await fetch("https://ryzeapi.cloud/api/instance/settings/my-instance", {
  method: "POST",
  headers: {
    "token":        process.env.Token_Instance,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({ autoReadMessages: true })
});

import os, requests

requests.post(
    "https://ryzeapi.cloud/api/instance/settings/my-instance",
    headers={
        "token":        os.environ["Token_Instance"],
        "Content-Type": "application/json"
    },
    json={"autoReadMessages": True}
)

package main

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

func main() {
    body := strings.NewReader(`{"autoReadMessages":true}`)
    req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/instance/settings/my-instance", body)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    req.Header.Set("Content-Type", "application/json")
    http.DefaultClient.Do(req)
}

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

await fetch("https://ryzeapi.cloud/api/instance/settings/my-instance", {
  method: "POST",
  headers: {
    "token":        process.env.Token_Instance,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    ignoreGroupMessages: true,
    ignoreStatus:        true,
    autoRejectCalls:     true,
    callRejectMessage:   "I do not take calls here."
  })
});

import os, requests

requests.post(
    "https://ryzeapi.cloud/api/instance/settings/my-instance",
    headers={
        "token":        os.environ["Token_Instance"],
        "Content-Type": "application/json"
    },
    json={
        "ignoreGroupMessages": True,
        "ignoreStatus":        True,
        "autoRejectCalls":     True,
        "callRejectMessage":   "I do not take calls here."
    }
)

package main

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

func main() {
    body := strings.NewReader(`{
        "ignoreGroupMessages": true,
        "ignoreStatus":        true,
        "autoRejectCalls":     true,
        "callRejectMessage":   "I do not take calls here."
    }`)
    req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/instance/settings/my-instance", body)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    req.Header.Set("Content-Type", "application/json")
    http.DefaultClient.Do(req)
}

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

string

required

Instance name.

Headers

string

required

TokenAccount or TokenInstance.

string

required

application/json.

Request body

boolean

Automatically rejects incoming calls.

string

Automatic message when rejecting a call.

boolean

Does not process messages received in groups.

boolean

Keeps presence as available. Applied immediately if the instance is connected.

boolean

Marks received messages as read.

boolean

default:"true"

Disables history synchronization on the first connect. Default true.

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

HTTP	`error.message`	When
400	`Invalid request body`	Malformed JSON.
400	`At least one setting must be provided`	Body without any field.
401	`Invalid token`	Token missing or invalid.
404	`Instance not found`	Name does not exist.
429	`Rate limit exceeded. Try again later.`	More than 100 req/min.
500	`Failed to update settings configuration`	Database error.

{
  "success": false,
  "error": {
    "message": "At least one setting must be provided"
  }
}

Introduction

Instance

Events

Messages

Calls

Groups

Communities

Newsletter

Profile

Chat

Chatwoot

Typebot

Observability

Update Settings

Description

Examples

Change only autoReadMessages

Anti-noise combo

Success response

Path parameters

Headers

Request body

Notes

Errors

​Description

​Examples

​Change only autoReadMessages

​Anti-noise combo

​Success response

​Path parameters

​Headers

​Request body

​Notes

​Errors

Description

Examples

Change only autoReadMessages

Anti-noise combo

Success response

Path parameters

Headers

Request body

Notes

Errors