Page routes: update, delete

Reference for Page, one group of Page routes.

Page.update

Changes the given properties of a Page. Verb page.

Text

PATCH /{namespace}/pages/{id}

Path: id. Body, as JSON: the other inputs. Emits Page.updated.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Page.
`path`	`string`		The path under its Site, such as `/pricing`.
`kind`	`string`		The page type, such as `landing`, `pricing`, or `terms`.
`from`	`string`		Lineage: the slot it compiles from, as `Hypothesis#<slot>@v<version>`.

Returns

Output	Type	Required	Description
`page`	Page	required	The Page.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.

Example

Terminal

curl -X PATCH https://api.sb/kilnbakery.com/pages/page_A8w9CXatRR \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"path":"/"}'

JSON

{
  "api": "https://api.sb/kilnbakery.com",
  "page": {
    "$id": "https://api.sb/kilnbakery.com/pages/page_A8w9CXatRR",
    "$type": "Page",
    "path": "/"
  },
  "action": {
    "$id": "https://api.sb/kilnbakery.com/actions/act_0y76a1jB6k",
    "operation": "Page.update",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/kilnbakery.com/actions/act_0y76a1jB6k"
  }
}

Page.delete

Deletes a Page: a soft delete that keeps its history, undone by Thing.restore. Verb page.