Approval routes: update, delete

Reference for Approval, one group of Approval routes.

Approval.update

Changes the given properties of an Approval. Verb page.

Text

PATCH /{namespace}/approvals/{id}

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

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Approval.
`by`	Worker		The Worker that performed it.
`for`	Party		The Party it was done on behalf of.
`via`	`string`		The Interface or request it arrived through.
`on`	`string`		The Action or Event that caused it, such as the failed attempt a retry follows.
`thing`	`string`		The record, at the Version the Action was decided against.
`input`	`json`		The input it was called with.
`createdAt`	`datetime`		When it was called.
`reserved`	`money`		The most this Action may cost, held against its Limits from the check until it settles, billed misses included.
`due`	`datetime`		When the Task is due.
`priority`	`integer`		Its rank in the inbox, highest first.
`recurrence`	`string`		The schedule a recurring duty repeats on.
`verdict`	`string`		One of `allowed` or `refused`.
`deadline`	`datetime`		When an unanswered Approval cancels the Action.

Returns

Output	Type	Required	Description
`approval`	Approval	required	The Approval.

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

Terminal

curl -X PATCH https://api.sb/leaseline.app/approvals/approval_TlxQeWh9uX \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"verdict":"allowed"}'

JSON

{
  "api": "https://api.sb/leaseline.app",
  "approval": {
    "$id": "https://api.sb/leaseline.app/approvals/approval_TlxQeWh9uX",
    "$type": "Approval",
    "status": "pending",
    "mode": "try",
    "verdict": "allowed"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Approval.update",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Approval.delete

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