Create a setting

Create a setting

POST /settings

Create a setting

cURL

curl --request POST \
  --url https://api.togai.com/settings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "UserSetting",
  "value": "INR",
  "entityType": "ORGANIZATION",
  "entityId": "XlK5h64gND",
  "namespace": "USER",
  "name": "Settings Name",
  "dataType": "STRING"
}
'

import requests

url = "https://api.togai.com/settings"

payload = {
    "id": "UserSetting",
    "value": "INR",
    "entityType": "ORGANIZATION",
    "entityId": "XlK5h64gND",
    "namespace": "USER",
    "name": "Settings Name",
    "dataType": "STRING"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    id: 'UserSetting',
    value: 'INR',
    entityType: 'ORGANIZATION',
    entityId: 'XlK5h64gND',
    namespace: 'USER',
    name: 'Settings Name',
    dataType: 'STRING'
  })
};

fetch('https://api.togai.com/settings', 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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'id' => 'UserSetting',
    'value' => 'INR',
    'entityType' => 'ORGANIZATION',
    'entityId' => 'XlK5h64gND',
    'namespace' => 'USER',
    'name' => 'Settings Name',
    'dataType' => 'STRING'
  ]),
  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"

	payload := strings.NewReader("{\n  \"id\": \"UserSetting\",\n  \"value\": \"INR\",\n  \"entityType\": \"ORGANIZATION\",\n  \"entityId\": \"XlK5h64gND\",\n  \"namespace\": \"USER\",\n  \"name\": \"Settings Name\",\n  \"dataType\": \"STRING\"\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.togai.com/settings")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"id\": \"UserSetting\",\n  \"value\": \"INR\",\n  \"entityType\": \"ORGANIZATION\",\n  \"entityId\": \"XlK5h64gND\",\n  \"namespace\": \"USER\",\n  \"name\": \"Settings Name\",\n  \"dataType\": \"STRING\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"id\": \"UserSetting\",\n  \"value\": \"INR\",\n  \"entityType\": \"ORGANIZATION\",\n  \"entityId\": \"XlK5h64gND\",\n  \"namespace\": \"USER\",\n  \"name\": \"Settings Name\",\n  \"dataType\": \"STRING\"\n}"

response = http.request(request)
puts response.read_body

201

{
  "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.

Body

application/json

Payload to insert setting

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

Response

201

application/json

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