Skip to main content
PUT
/
tenant
/
branding
curl --request PUT \
  --url https://api.royalti.io/tenant/branding \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "enabled": true,
  "tokens": {
    "brandPrimary": "#006666",
    "brandAccent": "#0D9488",
    "brandFont": "Plus Jakarta Sans",
    "logo": "https://cdn.yourlabel.com/logo.svg"
  }
}
'
{
  "status": "success",
  "message": "Branding updated successfully",
  "data": {
    "brandTokens": {
      "brandPrimary": "#006666",
      "brandAccent": "#0D9488",
      "logo": "<string>",
      "logoMark": "<string>"
    },
    "brandTokensEnabled": true
  }
}
{
  "status": "error",
  "message": "<string>",
  "code": "<string>",
  "details": {}
}
{
  "status": "error",
  "message": "<string>",
  "code": "<string>",
  "details": {}
}
This endpoint requires authentication. Include your Bearer token in the Authorization header.

​
Description

PUT /tenant/branding Description: Updates the enabled toggle and/or the brand token set. When tokens is supplied, brandPrimary, brandAccent, and brandFont are all required; logo/logoMark are optional and merge onto the existing stored values when omitted (send null to clear either). logo/logoMark must be https:// URLs. Authorization:
  • Required role: admin or higher
Method: PUT

​
Code Examples

const response = await fetch('https://api.royalti.io/tenant/branding', {
  method: 'PUT',
  headers: {
    'Authorization': `Bearer ${token}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "ref": "#/components/schemas/UpdateTenantBrandingRequest"
  })
});

const data = await response.json();
console.log(data);

import requests

response = requests.put(
  'https://api.royalti.io/tenant/branding',
  headers={
    'Authorization': f'Bearer {token}'
  },
  json={"ref":"#/components/schemas/UpdateTenantBrandingRequest"}
)

data = response.json()
print(data)

curl -X PUT https://api.royalti.io/tenant/branding \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"ref":"#/components/schemas/UpdateTenantBrandingRequest"}'

Authorizations

​
Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"

Body

application/json

Provide at least one of enabled or tokens. Omitted logo/logoMark keys preserve the existing stored value.

​
enabled
boolean

Whether custom branding is applied to this tenant's workspace/emails.

​
tokens
object

All of brandPrimary/brandAccent/brandFont are required when tokens is supplied.

Response

Branding updated

​
status
string
Example:

"success"

​
message
string
Example:

"Branding updated successfully"

​
data
object