Skip to content

Theme routes: update, delete

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

Reference for Theme, one group of Theme routes.

Theme.update

Changes the given properties of a Theme. Verb page.

Text
PATCH /{namespace}/themes/{id}

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

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Theme.
tokensjsonThe token values, in light and dark modes.
csstextExtra CSS, applied after the tokens.

Returns

OutputTypeRequiredDescription
themeThemerequiredThe Theme.

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/themes/theme_sZHbu0W683 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"tokens":{}}'
JSON
{
  "api": "https://api.sb/kilnbakery.com",
  "theme": {
    "$id": "https://api.sb/kilnbakery.com/themes/theme_sZHbu0W683",
    "$type": "Theme",
    "tokens": {}
  },
  "action": {
    "$id": "https://api.sb/kilnbakery.com/actions/act_0y76a1jB6k",
    "operation": "Theme.update",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/kilnbakery.com/actions/act_0y76a1jB6k"
  }
}

Theme.delete

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

Text
DELETE /{namespace}/themes/{id}

Path: id. Emits Theme.deleted.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Theme.

Returns

OutputTypeRequiredDescription
themeThemerequiredThe Theme.

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/themes/theme_sZHbu0W683 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/kilnbakery.com",
  "theme": {
    "$id": "https://api.sb/kilnbakery.com/themes/theme_sZHbu0W683",
    "$type": "Theme",
    "tokens": {}
  },
  "action": {
    "$id": "https://api.sb/kilnbakery.com/actions/act_0y76a1jB6k",
    "operation": "Theme.delete",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/kilnbakery.com/actions/act_0y76a1jB6k"
  }
}