Update branding configuration for an organization (admin only)
curl --request PATCH \
--url http://0.0.0.0:3000/v1/organizations/{id}/branding \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"description": "<string>",
"branding": {
"logoUrl": "<string>",
"darkLogoUrl": "<string>",
"favicon": "<string>",
"darkFavicon": "<string>",
"color": "<string>",
"darkColor": "<string>"
},
"inviteBranding": {
"headline": "<string>",
"subheadline": "<string>",
"primaryButtonLabel": "<string>",
"backgroundImageUrl": "<string>",
"pageBackgroundColor": "<string>"
}
}
'import requests
url = "http://0.0.0.0:3000/v1/organizations/{id}/branding"
payload = {
"description": "<string>",
"branding": {
"logoUrl": "<string>",
"darkLogoUrl": "<string>",
"favicon": "<string>",
"darkFavicon": "<string>",
"color": "<string>",
"darkColor": "<string>"
},
"inviteBranding": {
"headline": "<string>",
"subheadline": "<string>",
"primaryButtonLabel": "<string>",
"backgroundImageUrl": "<string>",
"pageBackgroundColor": "<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({
description: '<string>',
branding: {
logoUrl: '<string>',
darkLogoUrl: '<string>',
favicon: '<string>',
darkFavicon: '<string>',
color: '<string>',
darkColor: '<string>'
},
inviteBranding: {
headline: '<string>',
subheadline: '<string>',
primaryButtonLabel: '<string>',
backgroundImageUrl: '<string>',
pageBackgroundColor: '<string>'
}
})
};
fetch('http://0.0.0.0:3000/v1/organizations/{id}/branding', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://0.0.0.0:3000/v1/organizations/{id}/branding",
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([
'description' => '<string>',
'branding' => [
'logoUrl' => '<string>',
'darkLogoUrl' => '<string>',
'favicon' => '<string>',
'darkFavicon' => '<string>',
'color' => '<string>',
'darkColor' => '<string>'
],
'inviteBranding' => [
'headline' => '<string>',
'subheadline' => '<string>',
'primaryButtonLabel' => '<string>',
'backgroundImageUrl' => '<string>',
'pageBackgroundColor' => '<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 := "http://0.0.0.0:3000/v1/organizations/{id}/branding"
payload := strings.NewReader("{\n \"description\": \"<string>\",\n \"branding\": {\n \"logoUrl\": \"<string>\",\n \"darkLogoUrl\": \"<string>\",\n \"favicon\": \"<string>\",\n \"darkFavicon\": \"<string>\",\n \"color\": \"<string>\",\n \"darkColor\": \"<string>\"\n },\n \"inviteBranding\": {\n \"headline\": \"<string>\",\n \"subheadline\": \"<string>\",\n \"primaryButtonLabel\": \"<string>\",\n \"backgroundImageUrl\": \"<string>\",\n \"pageBackgroundColor\": \"<string>\"\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("http://0.0.0.0:3000/v1/organizations/{id}/branding")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"description\": \"<string>\",\n \"branding\": {\n \"logoUrl\": \"<string>\",\n \"darkLogoUrl\": \"<string>\",\n \"favicon\": \"<string>\",\n \"darkFavicon\": \"<string>\",\n \"color\": \"<string>\",\n \"darkColor\": \"<string>\"\n },\n \"inviteBranding\": {\n \"headline\": \"<string>\",\n \"subheadline\": \"<string>\",\n \"primaryButtonLabel\": \"<string>\",\n \"backgroundImageUrl\": \"<string>\",\n \"pageBackgroundColor\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://0.0.0.0:3000/v1/organizations/{id}/branding")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"description\": \"<string>\",\n \"branding\": {\n \"logoUrl\": \"<string>\",\n \"darkLogoUrl\": \"<string>\",\n \"favicon\": \"<string>\",\n \"darkFavicon\": \"<string>\",\n \"color\": \"<string>\",\n \"darkColor\": \"<string>\"\n },\n \"inviteBranding\": {\n \"headline\": \"<string>\",\n \"subheadline\": \"<string>\",\n \"primaryButtonLabel\": \"<string>\",\n \"backgroundImageUrl\": \"<string>\",\n \"pageBackgroundColor\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"ok": true
}{
"message": "validation error"
}{
"error": "unauthorized"
}{
"error": "forbidden"
}{
"message": "not found"
}{
"error": "internal_error"
}Organizations
Update branding configuration for an organization (admin only)
PATCH
/
v1
/
organizations
/
{id}
/
branding
Update branding configuration for an organization (admin only)
curl --request PATCH \
--url http://0.0.0.0:3000/v1/organizations/{id}/branding \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"description": "<string>",
"branding": {
"logoUrl": "<string>",
"darkLogoUrl": "<string>",
"favicon": "<string>",
"darkFavicon": "<string>",
"color": "<string>",
"darkColor": "<string>"
},
"inviteBranding": {
"headline": "<string>",
"subheadline": "<string>",
"primaryButtonLabel": "<string>",
"backgroundImageUrl": "<string>",
"pageBackgroundColor": "<string>"
}
}
'import requests
url = "http://0.0.0.0:3000/v1/organizations/{id}/branding"
payload = {
"description": "<string>",
"branding": {
"logoUrl": "<string>",
"darkLogoUrl": "<string>",
"favicon": "<string>",
"darkFavicon": "<string>",
"color": "<string>",
"darkColor": "<string>"
},
"inviteBranding": {
"headline": "<string>",
"subheadline": "<string>",
"primaryButtonLabel": "<string>",
"backgroundImageUrl": "<string>",
"pageBackgroundColor": "<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({
description: '<string>',
branding: {
logoUrl: '<string>',
darkLogoUrl: '<string>',
favicon: '<string>',
darkFavicon: '<string>',
color: '<string>',
darkColor: '<string>'
},
inviteBranding: {
headline: '<string>',
subheadline: '<string>',
primaryButtonLabel: '<string>',
backgroundImageUrl: '<string>',
pageBackgroundColor: '<string>'
}
})
};
fetch('http://0.0.0.0:3000/v1/organizations/{id}/branding', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://0.0.0.0:3000/v1/organizations/{id}/branding",
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([
'description' => '<string>',
'branding' => [
'logoUrl' => '<string>',
'darkLogoUrl' => '<string>',
'favicon' => '<string>',
'darkFavicon' => '<string>',
'color' => '<string>',
'darkColor' => '<string>'
],
'inviteBranding' => [
'headline' => '<string>',
'subheadline' => '<string>',
'primaryButtonLabel' => '<string>',
'backgroundImageUrl' => '<string>',
'pageBackgroundColor' => '<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 := "http://0.0.0.0:3000/v1/organizations/{id}/branding"
payload := strings.NewReader("{\n \"description\": \"<string>\",\n \"branding\": {\n \"logoUrl\": \"<string>\",\n \"darkLogoUrl\": \"<string>\",\n \"favicon\": \"<string>\",\n \"darkFavicon\": \"<string>\",\n \"color\": \"<string>\",\n \"darkColor\": \"<string>\"\n },\n \"inviteBranding\": {\n \"headline\": \"<string>\",\n \"subheadline\": \"<string>\",\n \"primaryButtonLabel\": \"<string>\",\n \"backgroundImageUrl\": \"<string>\",\n \"pageBackgroundColor\": \"<string>\"\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("http://0.0.0.0:3000/v1/organizations/{id}/branding")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"description\": \"<string>\",\n \"branding\": {\n \"logoUrl\": \"<string>\",\n \"darkLogoUrl\": \"<string>\",\n \"favicon\": \"<string>\",\n \"darkFavicon\": \"<string>\",\n \"color\": \"<string>\",\n \"darkColor\": \"<string>\"\n },\n \"inviteBranding\": {\n \"headline\": \"<string>\",\n \"subheadline\": \"<string>\",\n \"primaryButtonLabel\": \"<string>\",\n \"backgroundImageUrl\": \"<string>\",\n \"pageBackgroundColor\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://0.0.0.0:3000/v1/organizations/{id}/branding")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"description\": \"<string>\",\n \"branding\": {\n \"logoUrl\": \"<string>\",\n \"darkLogoUrl\": \"<string>\",\n \"favicon\": \"<string>\",\n \"darkFavicon\": \"<string>\",\n \"color\": \"<string>\",\n \"darkColor\": \"<string>\"\n },\n \"inviteBranding\": {\n \"headline\": \"<string>\",\n \"subheadline\": \"<string>\",\n \"primaryButtonLabel\": \"<string>\",\n \"backgroundImageUrl\": \"<string>\",\n \"pageBackgroundColor\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"ok": true
}{
"message": "validation error"
}{
"error": "unauthorized"
}{
"error": "forbidden"
}{
"message": "not found"
}{
"error": "internal_error"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
ID da organização
Body
application/json
Response
Branding updated