Update the Brand Book
curl --request PATCH \
--url https://api.1club.ai/v1/platform/brand-book \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"accentColor": "#c2410c",
"keepBrandColors": true,
"guidelines": "<string>"
}
'import requests
url = "https://api.1club.ai/v1/platform/brand-book"
payload = {
"accentColor": "#c2410c",
"keepBrandColors": True,
"guidelines": "<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({accentColor: '#c2410c', keepBrandColors: true, guidelines: '<string>'})
};
fetch('https://api.1club.ai/v1/platform/brand-book', 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.1club.ai/v1/platform/brand-book",
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([
'accentColor' => '#c2410c',
'keepBrandColors' => true,
'guidelines' => '<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.1club.ai/v1/platform/brand-book"
payload := strings.NewReader("{\n \"accentColor\": \"#c2410c\",\n \"keepBrandColors\": true,\n \"guidelines\": \"<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.1club.ai/v1/platform/brand-book")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"accentColor\": \"#c2410c\",\n \"keepBrandColors\": true,\n \"guidelines\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.1club.ai/v1/platform/brand-book")
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 \"accentColor\": \"#c2410c\",\n \"keepBrandColors\": true,\n \"guidelines\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"primaryColor": "<string>",
"darkPrimaryColor": "<string>",
"accentColor": "<string>",
"headerColor": "<string>",
"darkHeaderColor": "<string>",
"backgroundColor": "<string>",
"textColor": "<string>",
"darkBackgroundColor": "<string>",
"darkTextColor": "<string>",
"logoUrl": "<string>",
"logoDarkUrl": "<string>",
"logoAltText": "<string>",
"iconUrl": "<string>",
"faviconUrl": "<string>",
"fontFamily": "<string>",
"headingFontFamily": "<string>",
"keepBrandColors": true,
"toneOfVoice": "professional",
"guidelines": "<string>"
}{
"error": "<string>",
"code": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"details": {}
}Brand Book
Update the Brand Book
Changes the fields sent and leaves the rest. Copy already written or translated stays as it is until it is rewritten. Applies at once for the whole organization. Setting accentColor recolours straight away every live website that has no accent of its own. Send null to clear a field. Logos and the other colours are changed on the Branding page in the dashboard. Refused with BRANDING_UPGRADE_REQUIRED on the Free plan. Requires organization:write.
PATCH
/
v1
/
platform
/
brand-book
Update the Brand Book
curl --request PATCH \
--url https://api.1club.ai/v1/platform/brand-book \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"accentColor": "#c2410c",
"keepBrandColors": true,
"guidelines": "<string>"
}
'import requests
url = "https://api.1club.ai/v1/platform/brand-book"
payload = {
"accentColor": "#c2410c",
"keepBrandColors": True,
"guidelines": "<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({accentColor: '#c2410c', keepBrandColors: true, guidelines: '<string>'})
};
fetch('https://api.1club.ai/v1/platform/brand-book', 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.1club.ai/v1/platform/brand-book",
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([
'accentColor' => '#c2410c',
'keepBrandColors' => true,
'guidelines' => '<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.1club.ai/v1/platform/brand-book"
payload := strings.NewReader("{\n \"accentColor\": \"#c2410c\",\n \"keepBrandColors\": true,\n \"guidelines\": \"<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.1club.ai/v1/platform/brand-book")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"accentColor\": \"#c2410c\",\n \"keepBrandColors\": true,\n \"guidelines\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.1club.ai/v1/platform/brand-book")
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 \"accentColor\": \"#c2410c\",\n \"keepBrandColors\": true,\n \"guidelines\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"primaryColor": "<string>",
"darkPrimaryColor": "<string>",
"accentColor": "<string>",
"headerColor": "<string>",
"darkHeaderColor": "<string>",
"backgroundColor": "<string>",
"textColor": "<string>",
"darkBackgroundColor": "<string>",
"darkTextColor": "<string>",
"logoUrl": "<string>",
"logoDarkUrl": "<string>",
"logoAltText": "<string>",
"iconUrl": "<string>",
"faviconUrl": "<string>",
"fontFamily": "<string>",
"headingFontFamily": "<string>",
"keepBrandColors": true,
"toneOfVoice": "professional",
"guidelines": "<string>"
}{
"error": "<string>",
"code": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"details": {}
}Authorizations
Body
application/json
Response
The Brand Book after the change
Was this page helpful?