Portal routes: update, delete

Reference for Portal, one group of Portal routes.

Portal.update

Changes the given properties of a Portal. Verb page.

Text

PATCH /{namespace}/portals/{id}

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

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Portal.
`path`	`string`		Where it is mounted on the Site, `/portal` by default.
`tools`	`string[]`		Developer tools a keyed Offer adds: `keys`, `usage`, `requests`, `watches`, `version` and `testMode`.

Returns

Output	Type	Required	Description
`portal`	Portal	required	The Portal.

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/portals/portal_DDBhWh6mF5 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"path":"/"}'

JSON

{
  "api": "https://api.sb/kilnbakery.com",
  "portal": {
    "$id": "https://api.sb/kilnbakery.com/portals/portal_DDBhWh6mF5",
    "$type": "Portal",
    "path": "/"
  },
  "action": {
    "$id": "https://api.sb/kilnbakery.com/actions/act_0y76a1jB6k",
    "operation": "Portal.update",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/kilnbakery.com/actions/act_0y76a1jB6k"
  }
}

Portal.delete

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