Brand
What your customers see. Readable and writable from the API and the console.
Read your branding
GET/v1/brand
The name, logo and colours your customers see anywhere Kleos renders something on your behalf.
Permission: brand:read
Response
{
"object": "brand",
"display_name": "Acme Dialer",
"logo_url": "https://cdn.acme.example/logo.svg",
"primary_color": "#0B1F3A",
"accent_color": "#C8A24A",
"email_from_name": "Acme Dialer",
"support_email": "help@acme.example",
"domain": "app.acme.example"
}Change your branding
PATCH/v1/brand
Send only the fields you want to change. Sending `null` clears one. Colours are hex; URLs must be https, because a logo served over http would downgrade every page it appears on — including your customers' onboarding.
Permission: brand:write
Body
| Field | Type | |
|---|---|---|
display_name | string | The name your customers see. |
logo_url | string | https URL to your logo. |
primary_color | string | Hex, e.g. #0B1F3A. |
accent_color | string | Hex, e.g. #C8A24A. |
email_from_name | string | The sender name on emails sent on your behalf. |
support_email | string | Where your customers should reply. |
domain | string | The domain your customers use you at. |
Response
{
"object": "brand",
"display_name": "Acme Dialer",
"logo_url": "https://cdn.acme.example/logo.svg",
"primary_color": "#0B1F3A",
"accent_color": "#C8A24A",
"email_from_name": "Acme Dialer",
"support_email": "help@acme.example",
"domain": "app.acme.example"
}Refusals
| Status | Code | When |
|---|---|---|
| 400 | invalid_brand_field | A colour was not hex, or a URL was not https. |