Skip to content

by Startups.Studio

Role.vacate

POST /{namespace}/roles/{role}/vacate

Vacate takes the Worker out of a Role, and the seat’s Tasks route to the Role it escalates to until a new Worker is staffed.

Noun: Role
Mode: do
Event: Role.vacated

You, to your agent

Vacate the latest role.

curl -X POST https://api.sb/tutorloop.com/roles/role_1/vacate \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"

import { $ } from 'startup-builder'

const role = await $.Role.vacate({ role: 'role_1' })

npx startup-builder do Role.vacate --json '{"role":"role_1"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Role.vacate({ role: 'role_1' })"
  }
}

Inputs

Input	Type	Required	Description
`role`	Role	required	The Role to empty.
`reason`	`text`		Why the seat empties.

Outputs

Output	Type	Required	Description
`role`	Role	required	The vacant Role.

Effects

Emits Role.vacated.
Performed by the People Lead.
Two-way: it runs at once, in the try, send and do modes.
Keeps the Role contract, its Processes and its Mailbox, so the next Worker inherits them unchanged.

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.	Role.vacate

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

Role.update

Previous Page

Role Review

Next Page