Skip to content

Human routes: update, delete

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

Reference for Human, one group of Human routes.

Human.update

Changes the given properties of a Human. Verb page.

Text
PATCH /{namespace}/humans/{id}

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

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Human.
namestringThe name the Worker goes by in a Startup.
instructionstextHow the Worker does its work.
emailemailThe address the Human signs in with.

Returns

OutputTypeRequiredDescription
humanHumanrequiredThe Human.

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/humans/human_EeCsrv4AOW \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"email":"dana@leaseline.app"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "human": {
    "$id": "https://api.sb/leaseline.app/humans/human_EeCsrv4AOW",
    "$type": "Human",
    "name": "Dana Okafor",
    "email": "dana@leaseline.app"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Human.update",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Human.delete

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

Text
DELETE /{namespace}/humans/{id}

Path: id. Emits Human.deleted.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Human.

Returns

OutputTypeRequiredDescription
humanHumanrequiredThe Human.

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/humans/human_EeCsrv4AOW \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "human": {
    "$id": "https://api.sb/leaseline.app/humans/human_EeCsrv4AOW",
    "$type": "Human",
    "name": "Dana Okafor",
    "email": "dana@leaseline.app"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Human.delete",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}