Mandate methods: update, delete

Reference for Mandate, one group of Mandate methods.

Mandate.update

Changes the given properties of a Mandate. Verb page.

TypeScript

interface MandateVerbs {
  update(input: MandateUpdateInput, options?: SB.CallOptions): SB.Call<Mandate>
}

Emits Mandate.updated.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Mandate.
`expiresAt`	`datetime`		When it lapses.
`limit`	Limit		The Limit that bounds it.
`verb`	`string`		The Verb it covers, as `Noun.verb`.
`topics`	`string[]`		What it may act on; an Action outside them becomes an Approval.
`channels`	list of Channel		The Channels it may send through.

Returns

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

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.	None.

Example

TypeScript

import { $ } from 'startup-builder'

const mandate = await $.Mandate.update({ id: 'mandate_mKKPrmFQYD', expiresAt: '2026-10-22T12:00:00Z' })

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

TypeScript

interface MandateVerbs {
  delete(input: MandateDeleteInput, options?: SB.CallOptions): SB.Call<Mandate>
}

Emits Mandate.deleted.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Mandate.

Returns

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

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.	None.

Example

TypeScript

import { $ } from 'startup-builder'

const mandate = await $.Mandate.delete({ id: 'mandate_mKKPrmFQYD' })