Skip to content

Thing routes: update, delete

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

Reference for Thing, one group of Thing routes.

Thing.update

Changes the given properties of a Thing. Verb page.

Text
PATCH /{namespace}/things/{id}

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

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Thing.
typelist of NounThe Nouns this Thing is an instance of.
outsidejsonThe ids this Thing has in outside tools, one per Integration, so a re-run matches instead of duplicating.

Returns

OutputTypeRequiredDescription
thingThingrequiredThe Thing.

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/things/thing_8ds0r9vvRl \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"type":["noun_v0akLUrXCN"]}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "thing": {
    "$id": "https://api.sb/leaseline.app/things/thing_8ds0r9vvRl",
    "$type": "Thing",
    "id": "Example id",
    "type": [
      "noun_v0akLUrXCN"
    ]
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Thing.update",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Thing.delete

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

Text
DELETE /{namespace}/things/{id}

Path: id. Emits Thing.deleted.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Thing.

Returns

OutputTypeRequiredDescription
thingThingrequiredThe Thing.

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/things/thing_8ds0r9vvRl \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "thing": {
    "$id": "https://api.sb/leaseline.app/things/thing_8ds0r9vvRl",
    "$type": "Thing",
    "id": "Example id",
    "type": [
      "noun_v0akLUrXCN"
    ]
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Thing.delete",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}