Pages

Reorder pages

Bulk-update the sidebar position of multiple pages in one transaction.

patch/orgs/pages/positions

Request

  • Base URL: https://api.useinvent.com
  • URL: https://api.useinvent.com/orgs/pages/positions
  • Auth: HTTP bearer

Query parameters

pagenumber

Page number

takenumber

Number of items to take

nextstring

Next page token (Only used on special endpoints)

progressiveboolean

Skip the total count: pagination-count is exact on the last page, and one more than the items so far while more pages exist (Only used on special endpoints)

Request body

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.