Skip to main content
PATCH
Edit a brand rule

Authorizations

Authorization
string
header
required

An API key: ab_...

Path Parameters

id
string
required

Rule id

Body

application/json
key
string

Renames the rule and its context versions, which share a key

Maximum string length: 120
Pattern: ^[a-z][a-zA-Z0-9]*(\.[a-z][a-zA-Z0-9]*)*$
value
any

Checked against the rule's type, which never changes

usage
string | null

How and when to use it, in Markdown (GFM)

Maximum string length: 10000
context
string | null

Only in this context; omit for the default

Maximum string length: 64
Pattern: ^[a-z0-9]+(-[a-z0-9]+)*$
assets
(string<uuid> | object)[]

Assets it points at, in order: an id, or { id, rendition }. Replaces the list

Maximum array length: 24
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)$

Response

The rule

data
object
required