Skip to main content
PATCH
Update a brand color

Authorizations

Authorization
string
header
required

Send your API key in the Authorization header as Bearer API_KEY. Account API keys work in every workspace you belong to: send X-Notra-Organization-Id with the workspace id or slug to choose one. Workspace endpoints require it when you belong to more than one workspace; GET /v1/me/workspaces works without it. Organization keys only accept their own workspace there.

Path Parameters

brandIdentityId
string
required
Minimum string length: 1
Pattern: ^[A-Za-z0-9_-]{1,100}$
Example:

"51c2f3aa-efdd-4e28-8e69-23fa2dfd3561"

colorId
string
required
Minimum string length: 1
Pattern: ^[A-Za-z0-9_-]{1,100}$
Example:

"8f2c1d4e-5b6a-4c3d-9e8f-7a6b5c4d3e2f"

Body

application/json
role
enum<string>
Available options:
primary,
secondary,
accent,
background,
foreground,
neutral,
custom
Example:

"primary"

name
string | null
Maximum string length: 120
lightValue
string
Pattern: ^#(?:[0-9a-f]{3}|[0-9a-f]{6}|[0-9a-f]{8})$/i
darkValue
string | null
Pattern: ^#(?:[0-9a-f]{3}|[0-9a-f]{6}|[0-9a-f]{8})$/i
usage
string | null
Maximum string length: 240

Response

Brand color updated successfully

organization
object
required
color
object
required