Pages

Update page

Update a page.

patch/orgs/pages/{page_ref}

Request

  • Base URL: https://api.useinvent.com
  • URL: https://api.useinvent.com/orgs/pages/{page_ref}
  • Auth: HTTP bearer

Path parameters

page_refstring required

Page slug or encoded page id

Request body

titlestring

Page title.

slugstring

New friendly URL segment (kebab-case), unique per org.

color'red' | 'orange' | 'amber' | 'yellow' | 'lime' | 'green' | 'teal' | 'cyan' | 'sky' | 'blue' | 'indigo' | 'violet' | 'purple' | 'fuchsia' | 'pink' | 'rose' | 'neutral'

Accent color, by name

parent_idstring nullable

Parent page id or slug. Reserved for nesting.

show_in_sidebarboolean

Whether the page appears in the sidebar.

archivedboolean

Whether the page is archived, which hides it from the page list.

readonlyboolean

Example request

{
  "title": "Store overview",
  "slug": "store-overview"
}

Response

idstring required
slugstring required

Friendly URL segment, unique per org.

titlestring nullable required

Page title.

color'red' | 'orange' | 'amber' | 'yellow' | 'lime' | 'green' | 'teal' | 'cyan' | 'sky' | 'blue' | 'indigo' | 'violet' | 'purple' | 'fuchsia' | 'pink' | 'rose' | 'neutral' required

Accent color, by name

parent_idstring nullable required

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

positioninteger required

Sidebar-zone order.

show_in_sidebarboolean required
archivedboolean required
readonlyboolean required

Locked: the UI hides all edit affordances until unlocked.

created_atstring date-time nullable required
updated_atstring date-time nullable required

Example response

{
  "id": "page_5Fb7…",
  "slug": "store-overview",
  "title": "Store overview"
}

Changes

No recorded changes to this operation across all 1 revision of this API.