curl --request PATCH \
--url https://api.stg.simnet.cloud/api/v1/user/settings/preferences \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"timezone": "<string>",
"language": "<string>",
"dateFormat": "<string>",
"timeFormat": "<string>",
"theme": "<string>",
"notificationsEmail": true,
"notificationsJobComplete": true,
"notificationsJobFailed": true,
"notificationsBilling": true,
"organizationName": "<string>",
"organizationDescription": "<string>",
"organizationWebsite": "<string>",
"organizationLogoUrl": "<string>",
"maintenanceDay": 123,
"maintenanceStartTime": "<string>",
"maintenanceEndTime": "<string>"
}
'import requests
url = "https://api.stg.simnet.cloud/api/v1/user/settings/preferences"
payload = {
"timezone": "<string>",
"language": "<string>",
"dateFormat": "<string>",
"timeFormat": "<string>",
"theme": "<string>",
"notificationsEmail": True,
"notificationsJobComplete": True,
"notificationsJobFailed": True,
"notificationsBilling": True,
"organizationName": "<string>",
"organizationDescription": "<string>",
"organizationWebsite": "<string>",
"organizationLogoUrl": "<string>",
"maintenanceDay": 123,
"maintenanceStartTime": "<string>",
"maintenanceEndTime": "<string>"
}
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({
timezone: '<string>',
language: '<string>',
dateFormat: '<string>',
timeFormat: '<string>',
theme: '<string>',
notificationsEmail: true,
notificationsJobComplete: true,
notificationsJobFailed: true,
notificationsBilling: true,
organizationName: '<string>',
organizationDescription: '<string>',
organizationWebsite: '<string>',
organizationLogoUrl: '<string>',
maintenanceDay: 123,
maintenanceStartTime: '<string>',
maintenanceEndTime: '<string>'
})
};
fetch('https://api.stg.simnet.cloud/api/v1/user/settings/preferences', 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.stg.simnet.cloud/api/v1/user/settings/preferences",
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([
'timezone' => '<string>',
'language' => '<string>',
'dateFormat' => '<string>',
'timeFormat' => '<string>',
'theme' => '<string>',
'notificationsEmail' => true,
'notificationsJobComplete' => true,
'notificationsJobFailed' => true,
'notificationsBilling' => true,
'organizationName' => '<string>',
'organizationDescription' => '<string>',
'organizationWebsite' => '<string>',
'organizationLogoUrl' => '<string>',
'maintenanceDay' => 123,
'maintenanceStartTime' => '<string>',
'maintenanceEndTime' => '<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.stg.simnet.cloud/api/v1/user/settings/preferences"
payload := strings.NewReader("{\n \"timezone\": \"<string>\",\n \"language\": \"<string>\",\n \"dateFormat\": \"<string>\",\n \"timeFormat\": \"<string>\",\n \"theme\": \"<string>\",\n \"notificationsEmail\": true,\n \"notificationsJobComplete\": true,\n \"notificationsJobFailed\": true,\n \"notificationsBilling\": true,\n \"organizationName\": \"<string>\",\n \"organizationDescription\": \"<string>\",\n \"organizationWebsite\": \"<string>\",\n \"organizationLogoUrl\": \"<string>\",\n \"maintenanceDay\": 123,\n \"maintenanceStartTime\": \"<string>\",\n \"maintenanceEndTime\": \"<string>\"\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.stg.simnet.cloud/api/v1/user/settings/preferences")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"timezone\": \"<string>\",\n \"language\": \"<string>\",\n \"dateFormat\": \"<string>\",\n \"timeFormat\": \"<string>\",\n \"theme\": \"<string>\",\n \"notificationsEmail\": true,\n \"notificationsJobComplete\": true,\n \"notificationsJobFailed\": true,\n \"notificationsBilling\": true,\n \"organizationName\": \"<string>\",\n \"organizationDescription\": \"<string>\",\n \"organizationWebsite\": \"<string>\",\n \"organizationLogoUrl\": \"<string>\",\n \"maintenanceDay\": 123,\n \"maintenanceStartTime\": \"<string>\",\n \"maintenanceEndTime\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.stg.simnet.cloud/api/v1/user/settings/preferences")
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 \"timezone\": \"<string>\",\n \"language\": \"<string>\",\n \"dateFormat\": \"<string>\",\n \"timeFormat\": \"<string>\",\n \"theme\": \"<string>\",\n \"notificationsEmail\": true,\n \"notificationsJobComplete\": true,\n \"notificationsJobFailed\": true,\n \"notificationsBilling\": true,\n \"organizationName\": \"<string>\",\n \"organizationDescription\": \"<string>\",\n \"organizationWebsite\": \"<string>\",\n \"organizationLogoUrl\": \"<string>\",\n \"maintenanceDay\": 123,\n \"maintenanceStartTime\": \"<string>\",\n \"maintenanceEndTime\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"jobId": "8f2c41a9-3e77-4d60-b1aa-9c05e2f4d811",
"id": "b6d0e719-2c48-4a13-9f52-7e1b3a08c6d4"
}{
"message": "Operation failed",
"timestamp": "2023-11-07T05:31:56Z",
"detail": "Unable to find a suitable host"
}{
"message": "Operation failed",
"timestamp": "2023-11-07T05:31:56Z",
"detail": "Unable to find a suitable host"
}{
"message": "Operation failed",
"timestamp": "2023-11-07T05:31:56Z",
"detail": "Unable to find a suitable host"
}{
"message": "Operation failed",
"timestamp": "2023-11-07T05:31:56Z",
"detail": "Unable to find a suitable host"
}{
"message": "Operation failed",
"timestamp": "2023-11-07T05:31:56Z",
"detail": "Unable to find a suitable host"
}Update Preferences
PATCH /api/v1/user/settings/preferences
curl --request PATCH \
--url https://api.stg.simnet.cloud/api/v1/user/settings/preferences \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"timezone": "<string>",
"language": "<string>",
"dateFormat": "<string>",
"timeFormat": "<string>",
"theme": "<string>",
"notificationsEmail": true,
"notificationsJobComplete": true,
"notificationsJobFailed": true,
"notificationsBilling": true,
"organizationName": "<string>",
"organizationDescription": "<string>",
"organizationWebsite": "<string>",
"organizationLogoUrl": "<string>",
"maintenanceDay": 123,
"maintenanceStartTime": "<string>",
"maintenanceEndTime": "<string>"
}
'import requests
url = "https://api.stg.simnet.cloud/api/v1/user/settings/preferences"
payload = {
"timezone": "<string>",
"language": "<string>",
"dateFormat": "<string>",
"timeFormat": "<string>",
"theme": "<string>",
"notificationsEmail": True,
"notificationsJobComplete": True,
"notificationsJobFailed": True,
"notificationsBilling": True,
"organizationName": "<string>",
"organizationDescription": "<string>",
"organizationWebsite": "<string>",
"organizationLogoUrl": "<string>",
"maintenanceDay": 123,
"maintenanceStartTime": "<string>",
"maintenanceEndTime": "<string>"
}
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({
timezone: '<string>',
language: '<string>',
dateFormat: '<string>',
timeFormat: '<string>',
theme: '<string>',
notificationsEmail: true,
notificationsJobComplete: true,
notificationsJobFailed: true,
notificationsBilling: true,
organizationName: '<string>',
organizationDescription: '<string>',
organizationWebsite: '<string>',
organizationLogoUrl: '<string>',
maintenanceDay: 123,
maintenanceStartTime: '<string>',
maintenanceEndTime: '<string>'
})
};
fetch('https://api.stg.simnet.cloud/api/v1/user/settings/preferences', 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.stg.simnet.cloud/api/v1/user/settings/preferences",
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([
'timezone' => '<string>',
'language' => '<string>',
'dateFormat' => '<string>',
'timeFormat' => '<string>',
'theme' => '<string>',
'notificationsEmail' => true,
'notificationsJobComplete' => true,
'notificationsJobFailed' => true,
'notificationsBilling' => true,
'organizationName' => '<string>',
'organizationDescription' => '<string>',
'organizationWebsite' => '<string>',
'organizationLogoUrl' => '<string>',
'maintenanceDay' => 123,
'maintenanceStartTime' => '<string>',
'maintenanceEndTime' => '<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.stg.simnet.cloud/api/v1/user/settings/preferences"
payload := strings.NewReader("{\n \"timezone\": \"<string>\",\n \"language\": \"<string>\",\n \"dateFormat\": \"<string>\",\n \"timeFormat\": \"<string>\",\n \"theme\": \"<string>\",\n \"notificationsEmail\": true,\n \"notificationsJobComplete\": true,\n \"notificationsJobFailed\": true,\n \"notificationsBilling\": true,\n \"organizationName\": \"<string>\",\n \"organizationDescription\": \"<string>\",\n \"organizationWebsite\": \"<string>\",\n \"organizationLogoUrl\": \"<string>\",\n \"maintenanceDay\": 123,\n \"maintenanceStartTime\": \"<string>\",\n \"maintenanceEndTime\": \"<string>\"\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.stg.simnet.cloud/api/v1/user/settings/preferences")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"timezone\": \"<string>\",\n \"language\": \"<string>\",\n \"dateFormat\": \"<string>\",\n \"timeFormat\": \"<string>\",\n \"theme\": \"<string>\",\n \"notificationsEmail\": true,\n \"notificationsJobComplete\": true,\n \"notificationsJobFailed\": true,\n \"notificationsBilling\": true,\n \"organizationName\": \"<string>\",\n \"organizationDescription\": \"<string>\",\n \"organizationWebsite\": \"<string>\",\n \"organizationLogoUrl\": \"<string>\",\n \"maintenanceDay\": 123,\n \"maintenanceStartTime\": \"<string>\",\n \"maintenanceEndTime\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.stg.simnet.cloud/api/v1/user/settings/preferences")
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 \"timezone\": \"<string>\",\n \"language\": \"<string>\",\n \"dateFormat\": \"<string>\",\n \"timeFormat\": \"<string>\",\n \"theme\": \"<string>\",\n \"notificationsEmail\": true,\n \"notificationsJobComplete\": true,\n \"notificationsJobFailed\": true,\n \"notificationsBilling\": true,\n \"organizationName\": \"<string>\",\n \"organizationDescription\": \"<string>\",\n \"organizationWebsite\": \"<string>\",\n \"organizationLogoUrl\": \"<string>\",\n \"maintenanceDay\": 123,\n \"maintenanceStartTime\": \"<string>\",\n \"maintenanceEndTime\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"jobId": "8f2c41a9-3e77-4d60-b1aa-9c05e2f4d811",
"id": "b6d0e719-2c48-4a13-9f52-7e1b3a08c6d4"
}{
"message": "Operation failed",
"timestamp": "2023-11-07T05:31:56Z",
"detail": "Unable to find a suitable host"
}{
"message": "Operation failed",
"timestamp": "2023-11-07T05:31:56Z",
"detail": "Unable to find a suitable host"
}{
"message": "Operation failed",
"timestamp": "2023-11-07T05:31:56Z",
"detail": "Unable to find a suitable host"
}{
"message": "Operation failed",
"timestamp": "2023-11-07T05:31:56Z",
"detail": "Unable to find a suitable host"
}{
"message": "Operation failed",
"timestamp": "2023-11-07T05:31:56Z",
"detail": "Unable to find a suitable host"
}Authorizations
The access token from a signed-in console session, sent as Authorization: Bearer <token>. It must be issued for the Simnet API audience — an identity token, or a token for another application, is refused with 401.
There are no API keys, client secrets or service accounts yet, so this is a personal, short-lived credential carrying your full account access. Programmatic credentials with role-based access are on the roadmap. See Authentication.
Headers
Body
Recovered from the handler, which reads this body key by key rather than binding it to a typed class. These are the keys it reads; anything else you send is ignored rather than rejected.
Response
Accepted. Most mutations are asynchronous: the response carries a jobId and the work continues behind it, so a 2xx here means the request was accepted rather than finished. Poll GET /api/v1/jobs/{jobId} until the job is terminal before reading anything the operation was meant to produce. A response with no jobId completed synchronously. See Asynchronous work.