Skip to content

Risk methods: update

The Risk Verbs update as typed SDK methods, with inputs, result, refusals and an example.

Reference for Risk, one group of Risk methods.

Risk.update

Changes the given properties of a Risk. Verb page.

TypeScript
interface RiskVerbs {
  update(input: RiskUpdateInput, options?: SB.CallOptions): SB.Call<Risk>
}

Emits Risk.updated.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Risk.
scopestringWhose Risk it is: startup or portfolio, for exposure shared across siblings.
likelihoodintegerHow likely it is within a year, from 1 (rare) to 5 (expected).
impactintegerHow much harm it does if it happens, from 1 (minor) to 5 (ends the Startup).
treatmentstringThe chosen response: treat, accept, transfer, or avoid.
ownerRoleThe Role that owns the Risk and its next review.
reviewBydateWhen the owner next scores it again.

Returns

OutputTypeRequiredDescription
riskRiskrequiredThe Risk.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

TypeScript
import { $ } from 'startup-builder'

const risk = await $.Risk.update({ id: 'risk_a3Rw0qcmRy', likelihood: 1 })