Skip to content

by Startups.Studio

Team Worker Human

Human.suspend

POST /{namespace}/humans/{human}/suspend

Suspend stops a supplying Human from taking new Tasks while a Credential lapses or a dispute is open.

Noun: Human
Mode: do
Event: Human.suspended

You, to your agent

Suspend Rosa Ibarra.

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

import { $ } from 'startup-builder'

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

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

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

Inputs

Input	Type	Required	Description
`human`	Human	required	The Human to suspend.
`reason`	`text`	required	Why the Human stops.

Outputs

Output	Type	Required	Description
`human`	Human	required	The suspended Human.

Effects

Emits Human.suspended.
Performed by the Supply Manager.
Reassigns the Human’s open Tasks.

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

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

Previous Page

Human.update

Next Page