Skip to content

Mandate routes: update, delete

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

Reference for Mandate, one group of Mandate routes.

Mandate.update

Changes the given properties of a Mandate. Verb page.

Text
PATCH /{namespace}/mandates/{id}

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

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Mandate.
expiresAtdatetimeWhen it lapses.
limitLimitThe Limit that bounds it.
verbstringThe Verb it covers, as Noun.verb.
topicsstring[]What it may act on; an Action outside them becomes an Approval.
channelslist of ChannelThe Channels it may send through.

Returns

OutputTypeRequiredDescription
mandateMandaterequiredThe Mandate.

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/mandates/mandate_mKKPrmFQYD \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"expiresAt":"2026-10-22T12:00:00Z"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "mandate": {
    "$id": "https://api.sb/leaseline.app/mandates/mandate_mKKPrmFQYD",
    "$type": "Mandate",
    "expiresAt": "2026-10-22T12:00:00Z",
    "status": "active"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Mandate.update",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Mandate.delete

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

Text
DELETE /{namespace}/mandates/{id}

Path: id. Emits Mandate.deleted.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Mandate.

Returns

OutputTypeRequiredDescription
mandateMandaterequiredThe Mandate.

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/mandates/mandate_mKKPrmFQYD \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "mandate": {
    "$id": "https://api.sb/leaseline.app/mandates/mandate_mKKPrmFQYD",
    "$type": "Mandate",
    "expiresAt": "2026-10-22T12:00:00Z",
    "status": "active"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Mandate.delete",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}