Skip to content
StartupBuilder
by startups.studio
by Startups.Studio
Code
Changelog
APITeamMandate

Mandate routes: authorize, pause, resume

The Mandate Verbs authorize, pause, resume as api.sb routes, with inputs, result, refusals and an example.

Reference for Mandate, one group of Mandate routes.

Mandate.authorize

Authorize grants an Agent a standing Mandate to perform a Verb within a Limit, without asking each time. Verb page.

Text
POST /{namespace}/mandates/authorize

Body, as JSON: the inputs. Emits Mandate.authorized.

Inputs

InputTypeRequiredDescription
agentAgentrequiredThe agent that receives the Mandate.
verbstringrequiredThe Verb it covers, as Noun.verb.
limitLimitrequiredThe bound the Mandate holds to.
forPartyThe person the agent acts for, under delegation: the principal and author of record.
channelslist of ChannelThe Channels it may send through.
topicsstring[]What it may send about; a send outside them becomes an Approval.
approvejsonThe approval rule for one-way sends, such as the first 20 waiting for an Approval.
windowstringThe delay window each one-way send waits, as a duration.
expiresAtdatetimeWhen the Mandate lapses.

Returns

OutputTypeRequiredDescription
mandateMandaterequiredThe active Mandate.

Refuses when

CheckErrorFixThen call
The input does not match the schema of the operation.invalid-inputRead the schema of the operation, then send every required field with the right type.None.
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 POST https://api.sb/leaseline.app/mandates/authorize \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"agent":"agent_tCzKDMorKn","verb":"Example verb","limit":"limit_UWHXYVKsJB"}'
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.authorize",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Mandate.pause

Pause stops every new Action under a Mandate at once and keeps its scope, so it can resume unchanged. Verb page.

Text
POST /{namespace}/mandates/{mandate}/pause

Path: mandate. Body, as JSON: the other inputs. Emits Mandate.paused.

Inputs

InputTypeRequiredDescription
mandateMandaterequiredThe Mandate to hold.
reasontextWhy the Mandate stops.

Returns

OutputTypeRequiredDescription
mandateMandaterequiredThe paused 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 POST https://api.sb/leaseline.app/mandates/mandate_mKKPrmFQYD/pause \
  -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": "paused"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Mandate.pause",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Mandate.resume

Resume restarts a paused Mandate with its scope, Limits and approval rule unchanged. Verb page.

Text
POST /{namespace}/mandates/{mandate}/resume

Path: mandate. Emits Mandate.resumed.

Inputs

InputTypeRequiredDescription
mandateMandaterequiredThe paused Mandate.

Returns

OutputTypeRequiredDescription
mandateMandaterequiredThe active 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 POST https://api.sb/leaseline.app/mandates/mandate_mKKPrmFQYD/resume \
  -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.resume",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

update, delete

Previous

revoke, spend

Next