Skip to content

by Startups.Studio

Role.update

PATCH /{namespace}/roles/{id}

Changes the given properties of a Role.

Noun: Role
Mode: do
Event: Role.updated

You, to your agent

Change the latest role.

curl -X PATCH https://api.sb/routewise.dev/roles/role_1 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"RouteWise"}'

import { $ } from 'startup-builder'

const role = await $.Role.update({ id: 'role_1', name: 'RouteWise' })

npx startup-builder do Role.update --json '{"id":"role_1","name":"RouteWise"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Role.update({ id: 'role_1', name: 'RouteWise' })"
  }
}

Update changes the given properties of a Role. It is inherited: every Noun has get, list, create, update and delete.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Role.
`name`	`string`		The title of the seat.
`responsibilities`	`text`		The work the seat owns.
`autonomy`	`json`		How much its agent does without asking: a rung, `assist`, `supervised` or `full`, with another rung per decision class where it differs.

Outputs

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

Effects

Emits Role.updated.
Two-way: try, send, do.

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

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

Previous Page

Role.vacate

Next Page