cURL
curl --request PUT \
--url https://api.example.com/v1/panel/settings/theme \
--header 'Content-Type: application/json' \
--header 'X-CSRF-Token: <x-csrf-token>' \
--data '
{
"theme": {
"light": {},
"dark": {},
"allowedThemes": []
},
"version": 123
}
'import requests
url = "https://api.example.com/v1/panel/settings/theme"
payload = {
"theme": {
"light": {},
"dark": {},
"allowedThemes": []
},
"version": 123
}
headers = {
"X-CSRF-Token": "<x-csrf-token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-CSRF-Token': '<x-csrf-token>', 'Content-Type': 'application/json'},
body: JSON.stringify({theme: {light: {}, dark: {}, allowedThemes: []}, version: 123})
};
fetch('https://api.example.com/v1/panel/settings/theme', 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.example.com/v1/panel/settings/theme",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'theme' => [
'light' => [
],
'dark' => [
],
'allowedThemes' => [
]
],
'version' => 123
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-CSRF-Token: <x-csrf-token>"
],
]);
$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.example.com/v1/panel/settings/theme"
payload := strings.NewReader("{\n \"theme\": {\n \"light\": {},\n \"dark\": {},\n \"allowedThemes\": []\n },\n \"version\": 123\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("X-CSRF-Token", "<x-csrf-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.put("https://api.example.com/v1/panel/settings/theme")
.header("X-CSRF-Token", "<x-csrf-token>")
.header("Content-Type", "application/json")
.body("{\n \"theme\": {\n \"light\": {},\n \"dark\": {},\n \"allowedThemes\": []\n },\n \"version\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/panel/settings/theme")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-CSRF-Token"] = '<x-csrf-token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"theme\": {\n \"light\": {},\n \"dark\": {},\n \"allowedThemes\": []\n },\n \"version\": 123\n}"
response = http.request(request)
puts response.read_body{
"theme": {
"light": {},
"dark": {},
"radius": "square",
"density": "compact",
"allowedThemes": [
"light"
],
"defaultTheme": "light"
},
"css": "<string>",
"warnings": [
{
"code": "pair_unreadable",
"mode": "light",
"foreground": "<string>",
"background": "<string>",
"ratio": 123,
"blocking": true
}
],
"themable": [
"<string>"
],
"version": 123,
"updatedAt": "2023-11-07T05:31:56Z",
"updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"request_id": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"request_id": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"request_id": "<string>"
}panel
Put v1panelsettingstheme
Requires settings.write. Refused when any text pair falls below 3:1 against its own background, which is under the loosest threshold WCAG 2.2 defines for any text. A pair between 3:1 and 4.5:1 is saved and reported as a warning, because a brand tone that fails AA is a decision an operator is entitled to make and be told about.
PUT
/
v1
/
panel
/
settings
/
theme
cURL
curl --request PUT \
--url https://api.example.com/v1/panel/settings/theme \
--header 'Content-Type: application/json' \
--header 'X-CSRF-Token: <x-csrf-token>' \
--data '
{
"theme": {
"light": {},
"dark": {},
"allowedThemes": []
},
"version": 123
}
'import requests
url = "https://api.example.com/v1/panel/settings/theme"
payload = {
"theme": {
"light": {},
"dark": {},
"allowedThemes": []
},
"version": 123
}
headers = {
"X-CSRF-Token": "<x-csrf-token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-CSRF-Token': '<x-csrf-token>', 'Content-Type': 'application/json'},
body: JSON.stringify({theme: {light: {}, dark: {}, allowedThemes: []}, version: 123})
};
fetch('https://api.example.com/v1/panel/settings/theme', 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.example.com/v1/panel/settings/theme",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'theme' => [
'light' => [
],
'dark' => [
],
'allowedThemes' => [
]
],
'version' => 123
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-CSRF-Token: <x-csrf-token>"
],
]);
$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.example.com/v1/panel/settings/theme"
payload := strings.NewReader("{\n \"theme\": {\n \"light\": {},\n \"dark\": {},\n \"allowedThemes\": []\n },\n \"version\": 123\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("X-CSRF-Token", "<x-csrf-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.put("https://api.example.com/v1/panel/settings/theme")
.header("X-CSRF-Token", "<x-csrf-token>")
.header("Content-Type", "application/json")
.body("{\n \"theme\": {\n \"light\": {},\n \"dark\": {},\n \"allowedThemes\": []\n },\n \"version\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/panel/settings/theme")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-CSRF-Token"] = '<x-csrf-token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"theme\": {\n \"light\": {},\n \"dark\": {},\n \"allowedThemes\": []\n },\n \"version\": 123\n}"
response = http.request(request)
puts response.read_body{
"theme": {
"light": {},
"dark": {},
"radius": "square",
"density": "compact",
"allowedThemes": [
"light"
],
"defaultTheme": "light"
},
"css": "<string>",
"warnings": [
{
"code": "pair_unreadable",
"mode": "light",
"foreground": "<string>",
"background": "<string>",
"ratio": 123,
"blocking": true
}
],
"themable": [
"<string>"
],
"version": 123,
"updatedAt": "2023-11-07T05:31:56Z",
"updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"request_id": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"request_id": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"request_id": "<string>"
}Headers
Echoes the token from the current session. Required on every unsafe method.
Body
application/json
An operator's overrides. Every field is optional, and an omitted one keeps the design's own value. A palette maps a themable token name to a hex colour and accepts nothing else, because these values are rendered into a style element.
Show child attributes
Show child attributes
The version the screen was showing. A mismatch is a conflict rather than an overwrite.
Response
Saved
An operator's overrides. Every field is optional, and an omitted one keeps the design's own value. A palette maps a themable token name to a hex colour and accepts nothing else, because these values are rendered into a style element.
Show child attributes
Show child attributes
The declarations to inline. Empty when nothing has been customised.
Show child attributes
Show child attributes
The token names this build honours.