Skip to content

by Startups.Studio

Team Worker Human

Human.release

POST /{namespace}/humans/{human}/release

Release frees a held amount for payout once its Dispute closes or its clearance period ends.

Noun: Human
Mode: do
Event: Human.released

You, to your agent

Release Tomas Berg.

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

import { $ } from 'startup-builder'

const human = await $.Human.release({ human: 'human_1', cause: 'Example cause' })

npx startup-builder do Human.release --json '{"human":"human_1","cause":"Example cause"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Human.release({ human: 'human_1', cause: 'Example cause' })"
  }
}

Inputs

Input	Type	Required	Description
`human`	Human	required	The payee.
`cause`	`string`	required	The Order or Dispute whose hold ends.

Outputs

Output	Type	Required	Description
`human`	Human	required	The payee, with the hold removed.

Effects

Emits Human.released.
Performed by the Billing Specialist.
Two-way: it runs at once, in the try, send and do modes.
A lost Dispute releases nothing: the held amount returns to the Customer instead.

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

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

Previous Page

Human.remit

Next Page