Update tenant branding
curl --request PATCH \
--url https://app.msportal.ai/api/public/v1/tenant/branding \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"values": {
"logo_url": "<string>",
"logo_small_url": "<string>",
"logo_light_url": "<string>",
"logo_dark_url": "<string>",
"logo_small_light_url": "<string>",
"logo_small_dark_url": "<string>",
"favicon_url": "<string>",
"reporting_logo_url": "<string>",
"primaryColor": "<string>",
"signinBranding": {
"logoHeight": 72,
"backgroundColor": "<string>",
"gradientFrom": "<string>",
"gradientTo": "<string>",
"backgroundImagePath": "<string>",
"overlayOpacity": 40,
"welcomeTitle": "<string>",
"welcomeSubtitle": "<string>",
"helpInstructions": "<string>"
}
},
"expectedUpdatedAt": "2023-11-07T05:31:56Z"
}
'import requests
url = "https://app.msportal.ai/api/public/v1/tenant/branding"
payload = {
"values": {
"logo_url": "<string>",
"logo_small_url": "<string>",
"logo_light_url": "<string>",
"logo_dark_url": "<string>",
"logo_small_light_url": "<string>",
"logo_small_dark_url": "<string>",
"favicon_url": "<string>",
"reporting_logo_url": "<string>",
"primaryColor": "<string>",
"signinBranding": {
"logoHeight": 72,
"backgroundColor": "<string>",
"gradientFrom": "<string>",
"gradientTo": "<string>",
"backgroundImagePath": "<string>",
"overlayOpacity": 40,
"welcomeTitle": "<string>",
"welcomeSubtitle": "<string>",
"helpInstructions": "<string>"
}
},
"expectedUpdatedAt": "2023-11-07T05:31:56Z"
}
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({
values: {
logo_url: '<string>',
logo_small_url: '<string>',
logo_light_url: '<string>',
logo_dark_url: '<string>',
logo_small_light_url: '<string>',
logo_small_dark_url: '<string>',
favicon_url: '<string>',
reporting_logo_url: '<string>',
primaryColor: '<string>',
signinBranding: {
logoHeight: 72,
backgroundColor: '<string>',
gradientFrom: '<string>',
gradientTo: '<string>',
backgroundImagePath: '<string>',
overlayOpacity: 40,
welcomeTitle: '<string>',
welcomeSubtitle: '<string>',
helpInstructions: '<string>'
}
},
expectedUpdatedAt: '2023-11-07T05:31:56Z'
})
};
fetch('https://app.msportal.ai/api/public/v1/tenant/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_URL => "https://app.msportal.ai/api/public/v1/tenant/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([
'values' => [
'logo_url' => '<string>',
'logo_small_url' => '<string>',
'logo_light_url' => '<string>',
'logo_dark_url' => '<string>',
'logo_small_light_url' => '<string>',
'logo_small_dark_url' => '<string>',
'favicon_url' => '<string>',
'reporting_logo_url' => '<string>',
'primaryColor' => '<string>',
'signinBranding' => [
'logoHeight' => 72,
'backgroundColor' => '<string>',
'gradientFrom' => '<string>',
'gradientTo' => '<string>',
'backgroundImagePath' => '<string>',
'overlayOpacity' => 40,
'welcomeTitle' => '<string>',
'welcomeSubtitle' => '<string>',
'helpInstructions' => '<string>'
]
],
'expectedUpdatedAt' => '2023-11-07T05:31:56Z'
]),
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://app.msportal.ai/api/public/v1/tenant/branding"
payload := strings.NewReader("{\n \"values\": {\n \"logo_url\": \"<string>\",\n \"logo_small_url\": \"<string>\",\n \"logo_light_url\": \"<string>\",\n \"logo_dark_url\": \"<string>\",\n \"logo_small_light_url\": \"<string>\",\n \"logo_small_dark_url\": \"<string>\",\n \"favicon_url\": \"<string>\",\n \"reporting_logo_url\": \"<string>\",\n \"primaryColor\": \"<string>\",\n \"signinBranding\": {\n \"logoHeight\": 72,\n \"backgroundColor\": \"<string>\",\n \"gradientFrom\": \"<string>\",\n \"gradientTo\": \"<string>\",\n \"backgroundImagePath\": \"<string>\",\n \"overlayOpacity\": 40,\n \"welcomeTitle\": \"<string>\",\n \"welcomeSubtitle\": \"<string>\",\n \"helpInstructions\": \"<string>\"\n }\n },\n \"expectedUpdatedAt\": \"2023-11-07T05:31:56Z\"\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://app.msportal.ai/api/public/v1/tenant/branding")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"values\": {\n \"logo_url\": \"<string>\",\n \"logo_small_url\": \"<string>\",\n \"logo_light_url\": \"<string>\",\n \"logo_dark_url\": \"<string>\",\n \"logo_small_light_url\": \"<string>\",\n \"logo_small_dark_url\": \"<string>\",\n \"favicon_url\": \"<string>\",\n \"reporting_logo_url\": \"<string>\",\n \"primaryColor\": \"<string>\",\n \"signinBranding\": {\n \"logoHeight\": 72,\n \"backgroundColor\": \"<string>\",\n \"gradientFrom\": \"<string>\",\n \"gradientTo\": \"<string>\",\n \"backgroundImagePath\": \"<string>\",\n \"overlayOpacity\": 40,\n \"welcomeTitle\": \"<string>\",\n \"welcomeSubtitle\": \"<string>\",\n \"helpInstructions\": \"<string>\"\n }\n },\n \"expectedUpdatedAt\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.msportal.ai/api/public/v1/tenant/branding")
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 \"values\": {\n \"logo_url\": \"<string>\",\n \"logo_small_url\": \"<string>\",\n \"logo_light_url\": \"<string>\",\n \"logo_dark_url\": \"<string>\",\n \"logo_small_light_url\": \"<string>\",\n \"logo_small_dark_url\": \"<string>\",\n \"favicon_url\": \"<string>\",\n \"reporting_logo_url\": \"<string>\",\n \"primaryColor\": \"<string>\",\n \"signinBranding\": {\n \"logoHeight\": 72,\n \"backgroundColor\": \"<string>\",\n \"gradientFrom\": \"<string>\",\n \"gradientTo\": \"<string>\",\n \"backgroundImagePath\": \"<string>\",\n \"overlayOpacity\": 40,\n \"welcomeTitle\": \"<string>\",\n \"welcomeSubtitle\": \"<string>\",\n \"helpInstructions\": \"<string>\"\n }\n },\n \"expectedUpdatedAt\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"billing_email": "<string>",
"address_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"address_line1": "<string>",
"address_line2": "<string>",
"city": "<string>",
"province_state": "<string>",
"postal_code": "<string>",
"country": "<string>",
"country_code": "<string>",
"timezone": "<string>",
"locale": "<string>",
"currency": "<string>",
"custom_domain": "<string>",
"owner_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"logo_url": "<string>",
"logo_small_url": "<string>",
"logo_light_url": "<string>",
"logo_dark_url": "<string>",
"logo_small_light_url": "<string>",
"logo_small_dark_url": "<string>",
"favicon_url": "<string>",
"reporting_logo_url": "<string>",
"updated_at": "<string>",
"addressData": {
"street_address": "<string>",
"street_address_2": "<string>",
"city": "<string>",
"state_province": "<string>",
"postal_code": "<string>",
"country": "<string>",
"country_code": "<string>",
"formatted_address": "<string>",
"latitude": 123,
"longitude": 123,
"google_place_id": "<string>",
"osm_place_id": "<string>"
},
"primaryColor": "<string>",
"signinBranding": {
"logoHeight": 72,
"backgroundType": "default",
"backgroundColor": "<string>",
"gradientFrom": "<string>",
"gradientTo": "<string>",
"backgroundImagePath": "<string>",
"overlayOpacity": 40,
"cardStyle": "solid",
"welcomeTitle": "<string>",
"welcomeSubtitle": "<string>",
"helpInstructions": "<string>"
},
"settings": {}
}
}{
"error": "<string>",
"requestId": "<string>",
"details": "<unknown>",
"code": "<string>"
}{
"error": "<string>",
"requestId": "<string>",
"details": "<unknown>",
"code": "<string>"
}{
"error": "<string>",
"requestId": "<string>",
"details": "<unknown>",
"code": "<string>"
}{
"error": "<string>",
"requestId": "<string>",
"details": "<unknown>",
"code": "<string>"
}Tenant Setup
Update tenant branding
Update logos, favicon, reporting logo, primary brand color and the sign-in page design. Image paths must come from POST /tenant/branding/assets for this tenant. Requires tenant.write and manage_settings_tenant or manage_launch_center. MSP staff only.
PATCH
/
api
/
public
/
v1
/
tenant
/
branding
Update tenant branding
curl --request PATCH \
--url https://app.msportal.ai/api/public/v1/tenant/branding \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"values": {
"logo_url": "<string>",
"logo_small_url": "<string>",
"logo_light_url": "<string>",
"logo_dark_url": "<string>",
"logo_small_light_url": "<string>",
"logo_small_dark_url": "<string>",
"favicon_url": "<string>",
"reporting_logo_url": "<string>",
"primaryColor": "<string>",
"signinBranding": {
"logoHeight": 72,
"backgroundColor": "<string>",
"gradientFrom": "<string>",
"gradientTo": "<string>",
"backgroundImagePath": "<string>",
"overlayOpacity": 40,
"welcomeTitle": "<string>",
"welcomeSubtitle": "<string>",
"helpInstructions": "<string>"
}
},
"expectedUpdatedAt": "2023-11-07T05:31:56Z"
}
'import requests
url = "https://app.msportal.ai/api/public/v1/tenant/branding"
payload = {
"values": {
"logo_url": "<string>",
"logo_small_url": "<string>",
"logo_light_url": "<string>",
"logo_dark_url": "<string>",
"logo_small_light_url": "<string>",
"logo_small_dark_url": "<string>",
"favicon_url": "<string>",
"reporting_logo_url": "<string>",
"primaryColor": "<string>",
"signinBranding": {
"logoHeight": 72,
"backgroundColor": "<string>",
"gradientFrom": "<string>",
"gradientTo": "<string>",
"backgroundImagePath": "<string>",
"overlayOpacity": 40,
"welcomeTitle": "<string>",
"welcomeSubtitle": "<string>",
"helpInstructions": "<string>"
}
},
"expectedUpdatedAt": "2023-11-07T05:31:56Z"
}
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({
values: {
logo_url: '<string>',
logo_small_url: '<string>',
logo_light_url: '<string>',
logo_dark_url: '<string>',
logo_small_light_url: '<string>',
logo_small_dark_url: '<string>',
favicon_url: '<string>',
reporting_logo_url: '<string>',
primaryColor: '<string>',
signinBranding: {
logoHeight: 72,
backgroundColor: '<string>',
gradientFrom: '<string>',
gradientTo: '<string>',
backgroundImagePath: '<string>',
overlayOpacity: 40,
welcomeTitle: '<string>',
welcomeSubtitle: '<string>',
helpInstructions: '<string>'
}
},
expectedUpdatedAt: '2023-11-07T05:31:56Z'
})
};
fetch('https://app.msportal.ai/api/public/v1/tenant/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_URL => "https://app.msportal.ai/api/public/v1/tenant/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([
'values' => [
'logo_url' => '<string>',
'logo_small_url' => '<string>',
'logo_light_url' => '<string>',
'logo_dark_url' => '<string>',
'logo_small_light_url' => '<string>',
'logo_small_dark_url' => '<string>',
'favicon_url' => '<string>',
'reporting_logo_url' => '<string>',
'primaryColor' => '<string>',
'signinBranding' => [
'logoHeight' => 72,
'backgroundColor' => '<string>',
'gradientFrom' => '<string>',
'gradientTo' => '<string>',
'backgroundImagePath' => '<string>',
'overlayOpacity' => 40,
'welcomeTitle' => '<string>',
'welcomeSubtitle' => '<string>',
'helpInstructions' => '<string>'
]
],
'expectedUpdatedAt' => '2023-11-07T05:31:56Z'
]),
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://app.msportal.ai/api/public/v1/tenant/branding"
payload := strings.NewReader("{\n \"values\": {\n \"logo_url\": \"<string>\",\n \"logo_small_url\": \"<string>\",\n \"logo_light_url\": \"<string>\",\n \"logo_dark_url\": \"<string>\",\n \"logo_small_light_url\": \"<string>\",\n \"logo_small_dark_url\": \"<string>\",\n \"favicon_url\": \"<string>\",\n \"reporting_logo_url\": \"<string>\",\n \"primaryColor\": \"<string>\",\n \"signinBranding\": {\n \"logoHeight\": 72,\n \"backgroundColor\": \"<string>\",\n \"gradientFrom\": \"<string>\",\n \"gradientTo\": \"<string>\",\n \"backgroundImagePath\": \"<string>\",\n \"overlayOpacity\": 40,\n \"welcomeTitle\": \"<string>\",\n \"welcomeSubtitle\": \"<string>\",\n \"helpInstructions\": \"<string>\"\n }\n },\n \"expectedUpdatedAt\": \"2023-11-07T05:31:56Z\"\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://app.msportal.ai/api/public/v1/tenant/branding")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"values\": {\n \"logo_url\": \"<string>\",\n \"logo_small_url\": \"<string>\",\n \"logo_light_url\": \"<string>\",\n \"logo_dark_url\": \"<string>\",\n \"logo_small_light_url\": \"<string>\",\n \"logo_small_dark_url\": \"<string>\",\n \"favicon_url\": \"<string>\",\n \"reporting_logo_url\": \"<string>\",\n \"primaryColor\": \"<string>\",\n \"signinBranding\": {\n \"logoHeight\": 72,\n \"backgroundColor\": \"<string>\",\n \"gradientFrom\": \"<string>\",\n \"gradientTo\": \"<string>\",\n \"backgroundImagePath\": \"<string>\",\n \"overlayOpacity\": 40,\n \"welcomeTitle\": \"<string>\",\n \"welcomeSubtitle\": \"<string>\",\n \"helpInstructions\": \"<string>\"\n }\n },\n \"expectedUpdatedAt\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.msportal.ai/api/public/v1/tenant/branding")
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 \"values\": {\n \"logo_url\": \"<string>\",\n \"logo_small_url\": \"<string>\",\n \"logo_light_url\": \"<string>\",\n \"logo_dark_url\": \"<string>\",\n \"logo_small_light_url\": \"<string>\",\n \"logo_small_dark_url\": \"<string>\",\n \"favicon_url\": \"<string>\",\n \"reporting_logo_url\": \"<string>\",\n \"primaryColor\": \"<string>\",\n \"signinBranding\": {\n \"logoHeight\": 72,\n \"backgroundColor\": \"<string>\",\n \"gradientFrom\": \"<string>\",\n \"gradientTo\": \"<string>\",\n \"backgroundImagePath\": \"<string>\",\n \"overlayOpacity\": 40,\n \"welcomeTitle\": \"<string>\",\n \"welcomeSubtitle\": \"<string>\",\n \"helpInstructions\": \"<string>\"\n }\n },\n \"expectedUpdatedAt\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"billing_email": "<string>",
"address_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"address_line1": "<string>",
"address_line2": "<string>",
"city": "<string>",
"province_state": "<string>",
"postal_code": "<string>",
"country": "<string>",
"country_code": "<string>",
"timezone": "<string>",
"locale": "<string>",
"currency": "<string>",
"custom_domain": "<string>",
"owner_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"logo_url": "<string>",
"logo_small_url": "<string>",
"logo_light_url": "<string>",
"logo_dark_url": "<string>",
"logo_small_light_url": "<string>",
"logo_small_dark_url": "<string>",
"favicon_url": "<string>",
"reporting_logo_url": "<string>",
"updated_at": "<string>",
"addressData": {
"street_address": "<string>",
"street_address_2": "<string>",
"city": "<string>",
"state_province": "<string>",
"postal_code": "<string>",
"country": "<string>",
"country_code": "<string>",
"formatted_address": "<string>",
"latitude": 123,
"longitude": 123,
"google_place_id": "<string>",
"osm_place_id": "<string>"
},
"primaryColor": "<string>",
"signinBranding": {
"logoHeight": 72,
"backgroundType": "default",
"backgroundColor": "<string>",
"gradientFrom": "<string>",
"gradientTo": "<string>",
"backgroundImagePath": "<string>",
"overlayOpacity": 40,
"cardStyle": "solid",
"welcomeTitle": "<string>",
"welcomeSubtitle": "<string>",
"helpInstructions": "<string>"
},
"settings": {}
}
}{
"error": "<string>",
"requestId": "<string>",
"details": "<unknown>",
"code": "<string>"
}{
"error": "<string>",
"requestId": "<string>",
"details": "<unknown>",
"code": "<string>"
}{
"error": "<string>",
"requestId": "<string>",
"details": "<unknown>",
"code": "<string>"
}{
"error": "<string>",
"requestId": "<string>",
"details": "<unknown>",
"code": "<string>"
}Authorizations
Use your API key as a Bearer token. API keys can be generated in Settings → Integrations → API Access.
Body
application/json
Image fields take the path returned by POST /tenant/branding/assets. null removes an image, resets primaryColor or resets signinBranding; a non-null signinBranding replaces the whole design.
Response
Tenant setup after the update
Show child attributes
Show child attributes
Was this page helpful?