cURL
curl --request PATCH \
--url https://app.example.com/v1/admin/settings/operator \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"profile": {
"legalName": "<string>",
"tradingName": "<string>",
"email": "<string>",
"phone": "<string>",
"address": {},
"logoUrl": "<string>"
},
"paymentInstructions": {
"bankTransfer": {},
"notes": "<string>"
},
"paymentDefaults": {
"currency": "EUR",
"depositPercent": 123,
"balanceDueDays": 123
}
}'const response = await fetch("https://app.example.com/v1/admin/settings/operator", {
method: "PATCH",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer <token>"
},
body: JSON.stringify({
"profile": {
"legalName": "<string>",
"tradingName": "<string>",
"email": "<string>",
"phone": "<string>",
"address": {},
"logoUrl": "<string>"
},
"paymentInstructions": {
"bankTransfer": {},
"notes": "<string>"
},
"paymentDefaults": {
"currency": "EUR",
"depositPercent": 123,
"balanceDueDays": 123
}
}),
});
const data = await response.json();import requests
response = requests.patch(
"https://app.example.com/v1/admin/settings/operator",
headers={
"Authorization": "Bearer <token>"
},
json={
"profile": {
"legalName": "<string>",
"tradingName": "<string>",
"email": "<string>",
"phone": "<string>",
"address": {},
"logoUrl": "<string>"
},
"paymentInstructions": {
"bankTransfer": {},
"notes": "<string>"
},
"paymentDefaults": {
"currency": "EUR",
"depositPercent": 123,
"balanceDueDays": 123
}
}
)
data = response.json()<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{operatorDomain}/v1/admin/settings/operator",
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([
'profile' => [
'legalName' => '<string>',
'tradingName' => '<string>',
'email' => 'jsmith@example.com',
'phone' => '<string>',
'address' => [
],
'logoUrl' => '<string>'
],
'paymentInstructions' => [
'bankTransfer' => [
],
'notes' => '<string>'
],
'paymentDefaults' => [
'currency' => 'EUR',
'depositPercent' => 123,
'balanceDueDays' => 123
]
]),
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://{operatorDomain}/v1/admin/settings/operator"
payload := strings.NewReader("{\n \"profile\": {\n \"legalName\": \"<string>\",\n \"tradingName\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"address\": {},\n \"logoUrl\": \"<string>\"\n },\n \"paymentInstructions\": {\n \"bankTransfer\": {},\n \"notes\": \"<string>\"\n },\n \"paymentDefaults\": {\n \"currency\": \"EUR\",\n \"depositPercent\": 123,\n \"balanceDueDays\": 123\n }\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://{operatorDomain}/v1/admin/settings/operator")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"profile\": {\n \"legalName\": \"<string>\",\n \"tradingName\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"address\": {},\n \"logoUrl\": \"<string>\"\n },\n \"paymentInstructions\": {\n \"bankTransfer\": {},\n \"notes\": \"<string>\"\n },\n \"paymentDefaults\": {\n \"currency\": \"EUR\",\n \"depositPercent\": 123,\n \"balanceDueDays\": 123\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{operatorDomain}/v1/admin/settings/operator")
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 \"profile\": {\n \"legalName\": \"<string>\",\n \"tradingName\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"address\": {},\n \"logoUrl\": \"<string>\"\n },\n \"paymentInstructions\": {\n \"bankTransfer\": {},\n \"notes\": \"<string>\"\n },\n \"paymentDefaults\": {\n \"currency\": \"EUR\",\n \"depositPercent\": 123,\n \"balanceDueDays\": 123\n }\n}"
response = http.request(request)
puts response.read_body{
"profile": {
"legalName": "<string>",
"tradingName": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"address": {},
"logoUrl": "<string>"
},
"paymentInstructions": {
"bankTransfer": {},
"notes": "<string>"
},
"paymentDefaults": {
"currency": "EUR",
"depositPercent": 123,
"balanceDueDays": 123
}
}{
"error": "<string>",
"code": "<string>",
"requestId": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"requestId": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"requestId": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"requestId": "<string>",
"details": {}
}Settings
Update operator settings
Patch the combined operator settings.
PATCH
/
v1
/
admin
/
settings
/
operator
cURL
curl --request PATCH \
--url https://app.example.com/v1/admin/settings/operator \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"profile": {
"legalName": "<string>",
"tradingName": "<string>",
"email": "<string>",
"phone": "<string>",
"address": {},
"logoUrl": "<string>"
},
"paymentInstructions": {
"bankTransfer": {},
"notes": "<string>"
},
"paymentDefaults": {
"currency": "EUR",
"depositPercent": 123,
"balanceDueDays": 123
}
}'const response = await fetch("https://app.example.com/v1/admin/settings/operator", {
method: "PATCH",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer <token>"
},
body: JSON.stringify({
"profile": {
"legalName": "<string>",
"tradingName": "<string>",
"email": "<string>",
"phone": "<string>",
"address": {},
"logoUrl": "<string>"
},
"paymentInstructions": {
"bankTransfer": {},
"notes": "<string>"
},
"paymentDefaults": {
"currency": "EUR",
"depositPercent": 123,
"balanceDueDays": 123
}
}),
});
const data = await response.json();import requests
response = requests.patch(
"https://app.example.com/v1/admin/settings/operator",
headers={
"Authorization": "Bearer <token>"
},
json={
"profile": {
"legalName": "<string>",
"tradingName": "<string>",
"email": "<string>",
"phone": "<string>",
"address": {},
"logoUrl": "<string>"
},
"paymentInstructions": {
"bankTransfer": {},
"notes": "<string>"
},
"paymentDefaults": {
"currency": "EUR",
"depositPercent": 123,
"balanceDueDays": 123
}
}
)
data = response.json()<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{operatorDomain}/v1/admin/settings/operator",
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([
'profile' => [
'legalName' => '<string>',
'tradingName' => '<string>',
'email' => 'jsmith@example.com',
'phone' => '<string>',
'address' => [
],
'logoUrl' => '<string>'
],
'paymentInstructions' => [
'bankTransfer' => [
],
'notes' => '<string>'
],
'paymentDefaults' => [
'currency' => 'EUR',
'depositPercent' => 123,
'balanceDueDays' => 123
]
]),
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://{operatorDomain}/v1/admin/settings/operator"
payload := strings.NewReader("{\n \"profile\": {\n \"legalName\": \"<string>\",\n \"tradingName\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"address\": {},\n \"logoUrl\": \"<string>\"\n },\n \"paymentInstructions\": {\n \"bankTransfer\": {},\n \"notes\": \"<string>\"\n },\n \"paymentDefaults\": {\n \"currency\": \"EUR\",\n \"depositPercent\": 123,\n \"balanceDueDays\": 123\n }\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://{operatorDomain}/v1/admin/settings/operator")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"profile\": {\n \"legalName\": \"<string>\",\n \"tradingName\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"address\": {},\n \"logoUrl\": \"<string>\"\n },\n \"paymentInstructions\": {\n \"bankTransfer\": {},\n \"notes\": \"<string>\"\n },\n \"paymentDefaults\": {\n \"currency\": \"EUR\",\n \"depositPercent\": 123,\n \"balanceDueDays\": 123\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{operatorDomain}/v1/admin/settings/operator")
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 \"profile\": {\n \"legalName\": \"<string>\",\n \"tradingName\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"address\": {},\n \"logoUrl\": \"<string>\"\n },\n \"paymentInstructions\": {\n \"bankTransfer\": {},\n \"notes\": \"<string>\"\n },\n \"paymentDefaults\": {\n \"currency\": \"EUR\",\n \"depositPercent\": 123,\n \"balanceDueDays\": 123\n }\n}"
response = http.request(request)
puts response.read_body{
"profile": {
"legalName": "<string>",
"tradingName": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"address": {},
"logoUrl": "<string>"
},
"paymentInstructions": {
"bankTransfer": {},
"notes": "<string>"
},
"paymentDefaults": {
"currency": "EUR",
"depositPercent": 123,
"balanceDueDays": 123
}
}{
"error": "<string>",
"code": "<string>",
"requestId": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"requestId": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"requestId": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"requestId": "<string>",
"details": {}
}Authorizations
Staff session or API token issued by your Voyant app.
Body
application/json
⌘I