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"
}
'
import requests

url = "https://api.togai.com/settings/{setting_id_str}"

payload = {
"value": "{\"USD\":\"1\"}",
"name": "Base_Currency",
"dataType": "JSON"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({value: '{"USD":"1"}', name: 'Base_Currency', dataType: 'JSON'})
};

fetch('https://api.togai.com/settings/{setting_id_str}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.togai.com/settings/{setting_id_str}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'value' => '{"USD":"1"}',
'name' => 'Base_Currency',
'dataType' => 'JSON'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.togai.com/settings/{setting_id_str}"

payload := strings.NewReader("{\n \"value\": \"{\\\"USD\\\":\\\"1\\\"}\",\n \"name\": \"Base_Currency\",\n \"dataType\": \"JSON\"\n}")

req, _ := http.NewRequest("PATCH", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.patch("https://api.togai.com/settings/{setting_id_str}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"value\": \"{\\\"USD\\\":\\\"1\\\"}\",\n \"name\": \"Base_Currency\",\n \"dataType\": \"JSON\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.togai.com/settings/{setting_id_str}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"value\": \"{\\\"USD\\\":\\\"1\\\"}\",\n \"name\": \"Base_Currency\",\n \"dataType\": \"JSON\"\n}"

response = http.request(request)
puts response.read_body
{
  "id": "UserSetting",
  "value": "INR",
  "entityType": "ORGANIZATION",
  "entityId": "XlK5h64gND",
  "namespace": "USER",
  "name": "Settings Name",
  "dataType": "STRING"
}
{
"id": "UserSetting",
"value": "INR",
"entityType": "ORGANIZATION",
"entityId": "XlK5h64gND",
"namespace": "USER",
"name": "Settings Name",
"dataType": "STRING"
}
{
"message": "<Reason message>"
}
{
"message": "<Reason message>"
}
{
"message": "<Reason message>"
}
{
"message": "<Reason message>"
}
{
"message": "<Reason message>"
}
{
"message": "<Reason message>"
}

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