Risk routes: update · StartupBuilder

Reference for Risk, one group of Risk routes.

Risk.update

Changes the given properties of a Risk. Verb page.

Text

PATCH /{namespace}/risks/{id}

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

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Risk.
`scope`	`string`		Whose Risk it is: `startup` or `portfolio`, for exposure shared across siblings.
`likelihood`	`integer`		How likely it is within a year, from 1 (rare) to 5 (expected).
`impact`	`integer`		How much harm it does if it happens, from 1 (minor) to 5 (ends the Startup).
`treatment`	`string`		The chosen response: `treat`, `accept`, `transfer`, or `avoid`.
`owner`	Role		The Role that owns the Risk and its next review.
`reviewBy`	`date`		When the owner next scores it again.

Returns

Output	Type	Required	Description
`risk`	Risk	required	The Risk.

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/risks/risk_a3Rw0qcmRy \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"likelihood":1}'

JSON

{
  "api": "https://api.sb/leaseline.app",
  "risk": {
    "$id": "https://api.sb/leaseline.app/risks/risk_a3Rw0qcmRy",
    "$type": "Risk",
    "scope": "Example scope",
    "likelihood": 1,
    "impact": 1,
    "owner": "role_oloMFMUeCH"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Risk.update",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Risk.updateCopy Anchor Link

Risk.update