Skip to content
APIProductSites and appsSite

Site routes: update, delete

The Site Verbs update, delete as api.sb routes, with inputs, result, refusals and an example.

Reference for Site, one group of Site routes.

Site.update

Changes the given properties of a Site. Verb page.

Text
PATCH /{namespace}/sites/{id}

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

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Site.
kindstringOne of api, mcp, cli, sdk, site, app, docs, or webhooks.
pathstringWhere it is mounted on its Domain, such as /api.
conformsTojsonThe Standards it also speaks, each mapping the Standard’s operations onto the Product’s Verbs.
navigationjsonThe menus that link its Pages.

Returns

OutputTypeRequiredDescription
siteSiterequiredThe Site.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse 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/sites/site_kqt1HxwFab \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"navigation":{}}'
JSON
{
  "api": "https://api.sb/kilnbakery.com",
  "site": {
    "$id": "https://api.sb/kilnbakery.com/sites/site_kqt1HxwFab",
    "$type": "Site",
    "kind": "api",
    "navigation": {}
  },
  "action": {
    "$id": "https://api.sb/kilnbakery.com/actions/act_0y76a1jB6k",
    "operation": "Site.update",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/kilnbakery.com/actions/act_0y76a1jB6k"
  }
}

Site.delete

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

Text
DELETE /{namespace}/sites/{id}

Path: id. Emits Site.deleted.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Site.

Returns

OutputTypeRequiredDescription
siteSiterequiredThe Site.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl -X DELETE https://api.sb/kilnbakery.com/sites/site_kqt1HxwFab \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/kilnbakery.com",
  "site": {
    "$id": "https://api.sb/kilnbakery.com/sites/site_kqt1HxwFab",
    "$type": "Site",
    "kind": "api"
  },
  "action": {
    "$id": "https://api.sb/kilnbakery.com/actions/act_0y76a1jB6k",
    "operation": "Site.delete",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/kilnbakery.com/actions/act_0y76a1jB6k"
  }
}