Brand object
string (UUID)
required
Unique identifier for the brand.
string
required
Brand name (2–120 characters).
string
required
Brand website URL (max 255 characters).
string
required
CDN asset key or external URL for the brand logo (max 255 characters).
number
Percentage by which to scale the logo when displayed alongside other brand logos. Defaults to
100.boolean
required
When
true, the logo field is treated as an external URL rather than a CDN asset key.string (ISO 8601)
Timestamp when the brand was created.
string (ISO 8601)
Timestamp of the most recent update.
List brands
Public endpoint — no authentication required.
cURL
200
List brands (paged)
Public endpoint — no authentication required.
name.
number
default:"0"
Zero-based page index.
number
default:"20"
Number of items per page.
string
default:"name"
Field and direction, e.g.
name,asc.cURL
Get a brand
Public endpoint — no authentication required.
string (UUID)
required
The UUID of the brand to retrieve.
cURL
Create a brand
Creates a new brand. Returns201 Created with a Location header pointing to the new resource.
string
required
Brand name (2–120 characters).
string
required
Brand website URL (max 255 characters).
string
required
CDN asset key or external URL for the brand logo (max 255 characters). Set
logoUrl to true if you are supplying an external URL rather than a CDN key.number
Scaling percentage for the logo in composite displays. Defaults to
100.boolean
Set to
true when logo is an external URL instead of a CDN asset key. Defaults to false.cURL
201
Update a brand
Partially updates an existing brand. Only the fields you include are changed.string (UUID)
required
The UUID of the brand to update.
string
New brand name (2–120 characters).
string
New website URL (max 255 characters).
string
New CDN asset key or external URL (max 255 characters).
number
New scaling percentage for the logo.
boolean
Update whether
logo is an external URL (true) or a CDN key (false).cURL
200