Skip to main content
PATCH
Change a brand's theme

Authorizations

​
Authorization
string
header
required

An API key: ab_...

Path Parameters

​
slug
string
required

Brand slug

Body

application/json
​
accent
string | null

Color rule for links, marks and brand grounds; color.primary, brand or accent when left out

Maximum string length: 120
Pattern: ^[a-z][a-zA-Z0-9]*(\.[a-z][a-zA-Z0-9]*)*$
​
accentUse
enum<string> | null

hairline: the accent draws rules and marks, never fills

Available options:
fill,
hairline
​
surface
string | null

The page ground; color.background, surface or paper when left out, else the app's

Maximum string length: 120
Pattern: ^[a-z][a-zA-Z0-9]*(\.[a-z][a-zA-Z0-9]*)*$
​
panel
string | null

Panels and alternate sections; a step off the surface when left out

Maximum string length: 120
Pattern: ^[a-z][a-zA-Z0-9]*(\.[a-z][a-zA-Z0-9]*)*$
​
dark
string | null

The dark ground

Maximum string length: 120
Pattern: ^[a-z][a-zA-Z0-9]*(\.[a-z][a-zA-Z0-9]*)*$
​
ink
string | null

Text; color.ink, text or foreground when left out, else black or white by contrast

Maximum string length: 120
Pattern: ^[a-z][a-zA-Z0-9]*(\.[a-z][a-zA-Z0-9]*)*$
​
muted
string | null

Quiet text; mixed from ink and surface when left out

Maximum string length: 120
Pattern: ^[a-z][a-zA-Z0-9]*(\.[a-z][a-zA-Z0-9]*)*$
​
head
string | null

Font rule for headings

Maximum string length: 120
Pattern: ^[a-z][a-zA-Z0-9]*(\.[a-z][a-zA-Z0-9]*)*$
​
body
string | null

Font rule for text

Maximum string length: 120
Pattern: ^[a-z][a-zA-Z0-9]*(\.[a-z][a-zA-Z0-9]*)*$
​
label
string | null

Font rule for eyebrows, labels and running heads; its spec.case and spec.tracking set them

Maximum string length: 120
Pattern: ^[a-z][a-zA-Z0-9]*(\.[a-z][a-zA-Z0-9]*)*$
​
logo
string | null

The rule whose picture is the site's mark; logo.primary, mark or wordmark when left out

Maximum string length: 120
Pattern: ^[a-z][a-zA-Z0-9]*(\.[a-z][a-zA-Z0-9]*)*$
​
device
string<uuid> | null

An SVG asset: the brand's symbol or pattern for covers, dividers and pattern grounds

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
​
radius
integer | null

Corner radius in px

Required range: 0 <= x <= 40
​
width
enum<string> | null
Available options:
narrow,
normal,
wide
​
density
enum<string> | null
Available options:
compact,
normal,
airy
​
scale
number | null

Heading size ratio; 1.25 when left out

Required range: 1.067 <= x <= 1.618
​
nav
enum<string> | null
Available options:
sidebar,
top,
overlay
​
band
boolean | null

Every page opens on a band of the brand color; header band says the same

​
header
enum<string> | null

A page's opening: on the page, on a band of the brand color, or beside its cover

Available options:
plain,
band,
split
​
separation
enum<string> | null

Between two sections on the page's own ground: space alone, or a hairline too

Available options:
space,
hairline
​
numbering
boolean | null

Number chapters and pages: 01, 01.2

​
motion
enum<string> | null

subtle: sections reveal as they scroll in; never with reduced motion

Available options:
none,
subtle
​
toc
enum<string> | null

On this page: a side column, a list under the page header, or hidden

Available options:
side,
inline,
none
​
languages
object[] | null

The languages readers pick from; the first is the one the pages are written in

Maximum array length: 12

Response

The theme

​
data
object
required