Skip to content

by Startups.Studio

Mandate.revoke

POST /{namespace}/mandates/{mandate}/revoke

Revoke ends a Mandate at once, so new Actions under it are refused and running ones finish.

Noun: Mandate
Mode: do
Event: Mandate.revoked

You, to your agent

Revoke the latest mandate.

curl -X POST https://api.sb/petpantry.shop/mandates/mandate_1/revoke \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"

import { $ } from 'startup-builder'

const mandate = await $.Mandate.revoke({ mandate: 'mandate_1' })

npx startup-builder do Mandate.revoke --json '{"mandate":"mandate_1"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Mandate.revoke({ mandate: 'mandate_1' })"
  }
}

Inputs

Input	Type	Required	Description
`mandate`	Mandate	required	The Mandate to end.

Outputs

Output	Type	Required	Description
`mandate`	Mandate	required	The revoked Mandate.

Effects

Emits Mandate.revoked.
Performed by the Security Engineer.
Runs for every Mandate a person granted when their Customer’s directory removes them, in one Action with the key and Integration revokes.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	Mandate.revoke
The record is not in a state that allows this Verb, so the call is refused.	`refused`	Read the record, run the Verb that moves it to an allowed state, then retry.	Mandate.revoke

When it waits

Gate	Default
Decision class	Low: two-way, nothing at stake
Delay window	None: it runs once review passes.
Limit	The call Limit of the Permission it runs under.
Over the Limit	It waits `pending` for an Approval from the Founder. Approved, it runs; refused, it ends `refused` with `limit-exceeded`; unanswered by its deadline, it ends `canceled`.

Mandate.resume

Previous Page

Mandate.spend

Next Page