Skip to main content
PATCH
Update a page

Authorizations

Authorization
string
header
required

A workspace API key: Authorization: Bearer osk_...

Headers

If-Match
string
required

The current revision in quotes, from the resource's ETag. Missing returns 428; out of date returns 412.

Example:

"\"a1b2c3\""

Path Parameters

page
string<uuid>
required

Page ID.

Body

application/json
title
string
Maximum string length: 120
Example:

"Acme Studio"

slug
string | null
Maximum string length: 60
Example:

"acme"

domain
string<uuid> | null

A connected domain ID. Leave empty for the default domain.

handle
string | null
Maximum string length: 120
Example:

"@acmestudio"

tagline
string | null
Maximum string length: 280
theme
string

A theme from Get the catalogue.

hide_branding
boolean
avatar_color
string | null
Pattern: ^#[0-9a-fA-F]{6}$
Example:

"#4F46E5"

appearance
object
settings
object

Response

200 - application/json

Success

data
object