Skip to main content
PATCH
/
settings
/
{setting_id_str}
Update a setting
curl --request PATCH \
  --url https://api.togai.com/settings/{setting_id_str} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "value": "{\"USD\":\"1\"}",
  "name": "Base_Currency",
  "dataType": "JSON"
}
'
{
  "id": "UserSetting",
  "value": "INR",
  "entityType": "ORGANIZATION",
  "entityId": "XlK5h64gND",
  "namespace": "USER",
  "name": "Settings Name",
  "dataType": "STRING"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
setting_id_str
string
required
Example:

"setting.USER.success_threshold.ACCOUNT.G234DZZKBKACATFFGVGEMERFI"

Body

application/json

Payload to update setting

Update Settings

​
name
string
​
value
string
​
dataType
enum<string>
Available options:
STRING,
NUMERIC,
JSON,
JSON_LOGIC

Response

Response for insert and update settings request

Represents a setting

​
id
string
required
​
value
string
required
​
entityType
string
required
​
entityId
string
required
​
namespace
string
required
​
name
string
required
​
dataType
enum<string>
required
Available options:
STRING,
NUMERIC,
JSON,
JSON_LOGIC