Skip to content

Content routes: update, delete

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

Reference for Content, one group of Content routes.

Content.update

Changes the given properties of a Content. Verb page.

Text
PATCH /{namespace}/content/{id}

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

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Content.
titlestringThe headline.
publishedAtdatetimeWhen it went live.
kindstringWhat the Content is, so each System reads its own kind.

Returns

OutputTypeRequiredDescription
contentContentrequiredThe Content.

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/leaseline.app/content/content_HYlnoorBdP \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"title":"Leaseline Pro"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "content": {
    "$id": "https://api.sb/leaseline.app/content/content_HYlnoorBdP",
    "$type": "Content",
    "title": "Leaseline Pro"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Content.update",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Content.delete

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

Text
DELETE /{namespace}/content/{id}

Path: id. Emits Content.deleted.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Content.

Returns

OutputTypeRequiredDescription
contentContentrequiredThe Content.

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/leaseline.app/content/content_HYlnoorBdP \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "content": {
    "$id": "https://api.sb/leaseline.app/content/content_HYlnoorBdP",
    "$type": "Content",
    "title": "Leaseline Pro"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Content.delete",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}