Update workspace settings
curl --request PATCH \
--url https://api.example.com/api/v1/workspaces/{workspace}/settings \
--header 'Content-Type: application/json' \
--cookie geo.session= \
--data '
{
"displayName": "<string>",
"domains": [
"<string>"
],
"languages": [],
"about": "<string>",
"email": "jsmith@example.com",
"brandMeta": {
"faviconUrl": "",
"logoUrl": "<unknown>",
"fontNames": [
"<string>"
]
},
"productsServices": "<string>",
"designMd": "<string>"
}
'import requests
url = "https://api.example.com/api/v1/workspaces/{workspace}/settings"
payload = {
"displayName": "<string>",
"domains": ["<string>"],
"languages": [],
"about": "<string>",
"email": "jsmith@example.com",
"brandMeta": {
"faviconUrl": "",
"logoUrl": "<unknown>",
"fontNames": ["<string>"]
},
"productsServices": "<string>",
"designMd": "<string>"
}
headers = {
"cookie": "geo.session=",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {cookie: 'geo.session=', 'Content-Type': 'application/json'},
body: JSON.stringify({
displayName: '<string>',
domains: ['<string>'],
languages: [],
about: '<string>',
email: 'jsmith@example.com',
brandMeta: {faviconUrl: '', logoUrl: '<unknown>', fontNames: ['<string>']},
productsServices: '<string>',
designMd: '<string>'
})
};
fetch('https://api.example.com/api/v1/workspaces/{workspace}/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.example.com/api/v1/workspaces/{workspace}/settings",
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([
'displayName' => '<string>',
'domains' => [
'<string>'
],
'languages' => [
],
'about' => '<string>',
'email' => 'jsmith@example.com',
'brandMeta' => [
'faviconUrl' => '',
'logoUrl' => '<unknown>',
'fontNames' => [
'<string>'
]
],
'productsServices' => '<string>',
'designMd' => '<string>'
]),
CURLOPT_COOKIE => "geo.session=",
CURLOPT_HTTPHEADER => [
"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.example.com/api/v1/workspaces/{workspace}/settings"
payload := strings.NewReader("{\n \"displayName\": \"<string>\",\n \"domains\": [\n \"<string>\"\n ],\n \"languages\": [],\n \"about\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"brandMeta\": {\n \"faviconUrl\": \"\",\n \"logoUrl\": \"<unknown>\",\n \"fontNames\": [\n \"<string>\"\n ]\n },\n \"productsServices\": \"<string>\",\n \"designMd\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("cookie", "geo.session=")
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.example.com/api/v1/workspaces/{workspace}/settings")
.header("cookie", "geo.session=")
.header("Content-Type", "application/json")
.body("{\n \"displayName\": \"<string>\",\n \"domains\": [\n \"<string>\"\n ],\n \"languages\": [],\n \"about\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"brandMeta\": {\n \"faviconUrl\": \"\",\n \"logoUrl\": \"<unknown>\",\n \"fontNames\": [\n \"<string>\"\n ]\n },\n \"productsServices\": \"<string>\",\n \"designMd\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/workspaces/{workspace}/settings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["cookie"] = 'geo.session='
request["Content-Type"] = 'application/json'
request.body = "{\n \"displayName\": \"<string>\",\n \"domains\": [\n \"<string>\"\n ],\n \"languages\": [],\n \"about\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"brandMeta\": {\n \"faviconUrl\": \"\",\n \"logoUrl\": \"<unknown>\",\n \"fontNames\": [\n \"<string>\"\n ]\n },\n \"productsServices\": \"<string>\",\n \"designMd\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"ok": true,
"extractionRan": true,
"designMd": "<string>",
"updatedAt": "<string>",
"brandColors": {
"primary": "<string>",
"secondary": "<unknown>",
"accent": "<unknown>",
"background": "<unknown>",
"text": "<unknown>"
},
"brandMeta": {
"faviconUrl": "",
"logoUrl": "<unknown>",
"fontNames": [
"<string>"
]
},
"about": "<string>"
}API Reference
Update workspace settings
PATCH
/
api
/
v1
/
workspaces
/
{workspace}
/
settings
Update workspace settings
curl --request PATCH \
--url https://api.example.com/api/v1/workspaces/{workspace}/settings \
--header 'Content-Type: application/json' \
--cookie geo.session= \
--data '
{
"displayName": "<string>",
"domains": [
"<string>"
],
"languages": [],
"about": "<string>",
"email": "jsmith@example.com",
"brandMeta": {
"faviconUrl": "",
"logoUrl": "<unknown>",
"fontNames": [
"<string>"
]
},
"productsServices": "<string>",
"designMd": "<string>"
}
'import requests
url = "https://api.example.com/api/v1/workspaces/{workspace}/settings"
payload = {
"displayName": "<string>",
"domains": ["<string>"],
"languages": [],
"about": "<string>",
"email": "jsmith@example.com",
"brandMeta": {
"faviconUrl": "",
"logoUrl": "<unknown>",
"fontNames": ["<string>"]
},
"productsServices": "<string>",
"designMd": "<string>"
}
headers = {
"cookie": "geo.session=",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {cookie: 'geo.session=', 'Content-Type': 'application/json'},
body: JSON.stringify({
displayName: '<string>',
domains: ['<string>'],
languages: [],
about: '<string>',
email: 'jsmith@example.com',
brandMeta: {faviconUrl: '', logoUrl: '<unknown>', fontNames: ['<string>']},
productsServices: '<string>',
designMd: '<string>'
})
};
fetch('https://api.example.com/api/v1/workspaces/{workspace}/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.example.com/api/v1/workspaces/{workspace}/settings",
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([
'displayName' => '<string>',
'domains' => [
'<string>'
],
'languages' => [
],
'about' => '<string>',
'email' => 'jsmith@example.com',
'brandMeta' => [
'faviconUrl' => '',
'logoUrl' => '<unknown>',
'fontNames' => [
'<string>'
]
],
'productsServices' => '<string>',
'designMd' => '<string>'
]),
CURLOPT_COOKIE => "geo.session=",
CURLOPT_HTTPHEADER => [
"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.example.com/api/v1/workspaces/{workspace}/settings"
payload := strings.NewReader("{\n \"displayName\": \"<string>\",\n \"domains\": [\n \"<string>\"\n ],\n \"languages\": [],\n \"about\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"brandMeta\": {\n \"faviconUrl\": \"\",\n \"logoUrl\": \"<unknown>\",\n \"fontNames\": [\n \"<string>\"\n ]\n },\n \"productsServices\": \"<string>\",\n \"designMd\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("cookie", "geo.session=")
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.example.com/api/v1/workspaces/{workspace}/settings")
.header("cookie", "geo.session=")
.header("Content-Type", "application/json")
.body("{\n \"displayName\": \"<string>\",\n \"domains\": [\n \"<string>\"\n ],\n \"languages\": [],\n \"about\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"brandMeta\": {\n \"faviconUrl\": \"\",\n \"logoUrl\": \"<unknown>\",\n \"fontNames\": [\n \"<string>\"\n ]\n },\n \"productsServices\": \"<string>\",\n \"designMd\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/workspaces/{workspace}/settings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["cookie"] = 'geo.session='
request["Content-Type"] = 'application/json'
request.body = "{\n \"displayName\": \"<string>\",\n \"domains\": [\n \"<string>\"\n ],\n \"languages\": [],\n \"about\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"brandMeta\": {\n \"faviconUrl\": \"\",\n \"logoUrl\": \"<unknown>\",\n \"fontNames\": [\n \"<string>\"\n ]\n },\n \"productsServices\": \"<string>\",\n \"designMd\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"ok": true,
"extractionRan": true,
"designMd": "<string>",
"updatedAt": "<string>",
"brandColors": {
"primary": "<string>",
"secondary": "<unknown>",
"accent": "<unknown>",
"background": "<unknown>",
"text": "<unknown>"
},
"brandMeta": {
"faviconUrl": "",
"logoUrl": "<unknown>",
"fontNames": [
"<string>"
]
},
"about": "<string>"
}Authorizations
cookieAuthbearerAuth
Signed HttpOnly browser session cookie
Path Parameters
Pattern:
^[a-z0-9-]+$Body
application/json
Required string length:
2 - 60Required array length:
1 - 8 elementsPattern:
^([a-z0-9]([a-z0-9-]*[a-z0-9])?\.)+[a-z]{2,}$Required array length:
1 - 10 elementsAvailable options:
en, es, ca, fr Maximum string length:
4000Available options:
, financial-services, healthcare, technology, retail-ecommerce, professional-services, other Maximum string length:
254Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Maximum string length:
10000Maximum string length:
50000⌘I