Skip to content

by Startups.Studio

Team Worker Human

Human.hold

POST /{namespace}/humans/{human}/hold

Hold sets aside part of a supplying Human’s earned balance against an open Dispute or an Order inside its clearance period.

Noun: Human
Mode: do
Event: Human.held

You, to your agent

Hold Tomas Berg.

curl -X POST https://api.sb/kilnbakery.com/humans/human_1/hold \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"amount":{"amount":9,"currency":"USD"},"cause":"Example cause"}'

import { $ } from 'startup-builder'

const human = await $.Human.hold({ human: 'human_1', amount: { amount: 9, currency: 'USD' }, cause: 'Example cause' })

npx startup-builder do Human.hold --json '{"human":"human_1","amount":{"amount":9,"currency":"USD"},"cause":"Example cause"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Human.hold({ human: 'human_1', amount: { amount: 9, currency: 'USD' }, cause: 'Example cause' })"
  }
}

Inputs

Input	Type	Required	Description
`human`	Human	required	The payee.
`amount`	`money`	required	The amount to hold.
`cause`	`string`	required	The Order or Dispute the hold cites.

Outputs

Output	Type	Required	Description
`human`	Human	required	The payee, with the held amount recorded.

Effects

Emits Human.held.
Performed by the Billing Specialist.
Two-way: it runs at once, in the try, send and do modes.
Human.remit pays only the balance not held.

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.	Human.hold

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

Human.get

Previous Page

Human.invite

Next Page