Save organization brand
Save the organization's brand appearance as edited by the user. Stores the provided colors, logos, fonts and domain as-is without calling Brandfetch.
Authentication: personal access token. The spec defines an api_key security
scheme — send an Authorization: ApiKey <your-personal-access-token> header
(value format: ApiKey <your key>). A session_cookie scheme (connect.sid)
exists for browser sessions. Operations in this spec declare security: [], an
artifact of the upstream spec generator — authentication is still enforced by the
server.
Request body
{
"fonts": [
{
"origin": "string",
"type": "string",
"name": "string"
}
],
"colors": [
{
"brightness": 0,
"type": "string",
"hex": "string"
}
],
"logos": [
{
"format": "string",
"url": "string",
"theme": "string",
"type": "string"
}
],
"description": "string",
"name": "string",
"domain": "string"
}Responses
200 — Ok
{
"results": {
"updatedAt": "2024-01-01T00:00:00.000Z",
"fonts": [
{
"origin": "string",
"type": "string",
"name": "string"
}
],
"colors": [
{
"brightness": 0,
"type": "string",
"hex": "string"
}
],
"logos": [
{
"format": "string",
"url": "string",
"theme": "string",
"type": "string"
}
],
"description": "string",
"name": "string",
"domain": "string",
"organizationUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"status": "ok"
}default — Error
{
"error": {
"data": "string",
"message": "string",
"name": "string",
"statusCode": 0
},
"status": "error"
}Get organization brand
Get the organization's brand profile, previously fetched from Brandfetch. Returns null if no brand profile has been fetched yet.
Fetch organization brand
Fetch the brand profile for a domain from Brandfetch without storing it. Used to preview a brand in the appearance settings before saving. Requires the Brandfetch API key to be configured on the instance.