Role routes: update, delete

Reference for Role, one group of Role routes.

Role.update

Changes the given properties of a Role. Verb page.

Text

PATCH /{namespace}/roles/{id}

Path: id. Body, as JSON: the other inputs. Emits Role.updated.

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.
`approvals`	`json`		What waits for the founder: rules by action class (`spend`, `sign`, `publish`, `price`, `send`), each optionally above an amount in USD.

Returns

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

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

Example

Terminal

curl -X PATCH https://api.sb/leaseline.app/roles/role_oloMFMUeCH \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Leaseline"}'

JSON

{
  "api": "https://api.sb/leaseline.app",
  "role": {
    "$id": "https://api.sb/leaseline.app/roles/role_oloMFMUeCH",
    "$type": "Role",
    "name": "Leaseline",
    "status": "filled"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Role.update",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Role.delete

Deletes a Role: a soft delete that keeps its history, undone by Thing.restore. Verb page.