Skip to main content
PATCH
Update a page

Authorizations

Authorization
string
header
required

Bearer token authentication using your API key

Path Parameters

org_id
string
required

Org ID

page_ref
string
required

Page slug or encoded page id

Body

title
string

Page title.

Required string length: 1 - 255
Example:

"Store overview"

slug
string

Friendly URL segment, unique per org.

Required string length: 1 - 64
Pattern: ^[a-z][a-z0-9-]{0,63}$
Example:

"store-overview"

icon

The emoji of a curated icon a user can pick for a table, view, field, or other entity

color
enum<string> | null

The name of the color to use in the UI

Available options:
red,
orange,
amber,
yellow,
lime,
green,
teal,
cyan,
sky,
blue,
indigo,
violet,
purple,
fuchsia,
pink,
rose,
neutral
parent_id
string | null

Parent page id or slug. Reserved for nesting.

show_in_sidebar
boolean
archived
boolean
readonly
boolean

Response

200 - application/json
id
string
required
Example:

"page_5Fb7…"

slug
string
required

Friendly URL segment, unique per org.

Required string length: 1 - 64
Pattern: ^[a-z][a-z0-9-]{0,63}$
Example:

"store-overview"

title
string | null
required

Page title.

Required string length: 1 - 255
Example:

"Store overview"

icon
required

The emoji of a curated icon a user can pick for a table, view, field, or other entity

color
enum<string> | null
required

The name of the color to use in the UI

Available options:
red,
orange,
amber,
yellow,
lime,
green,
teal,
cyan,
sky,
blue,
indigo,
violet,
purple,
fuchsia,
pink,
rose,
neutral
parent_id
string | null
required

Parent page id. Reserved for nesting; unused by the UI.

position
integer
required

Sidebar-zone order.

show_in_sidebar
boolean
required
archived
boolean
required
readonly
boolean
required

Locked: the UI hides all edit affordances until unlocked.

created_at
string<date-time> | null
required
updated_at
string<date-time> | null
required