Portfolio methods: brake, lift
The Portfolio Verbs brake, lift as typed SDK methods, with inputs, result, refusals and an example.
Reference for Portfolio, one group of Portfolio methods.
Portfolio.brake
Brake stops one class of effects, such as sends, spend, publishes, or price changes, across a Portfolio query until it expires or is lifted. Verb page.
interface PortfolioVerbs {
brake(input: PortfolioBrakeInput, options?: SB.CallOptions): SB.Call<PortfolioBrakeOutput>
}Emits Portfolio.braked.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
portfolio | Portfolio | required | The Portfolio whose Startups the brake covers. |
effects | string[] | required | Any of send, spend, publish, and price. |
reason | text | required | Why the effects stop. |
until | datetime | required | When the brake expires. |
query | string | Narrows the brake to the Startups that match, such as one Startup Template Version or one Cohort. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
brake | Setting | required | The brake, held as a Setting that every matching Startup inherits. |
portfolio | Portfolio | required | The Portfolio under the brake. |
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
import { $ } from 'startup-builder'
const { brake, portfolio } = await $.Portfolio.brake({ portfolio: 'portfolio_zkvUnP8LwY', effects: ['send'], reason: 'Example reason', until: '2026-10-22T12:Portfolio.lift
Lift ends a brake before it expires, and the Actions it held resume their review and delay windows. Verb page.
interface PortfolioVerbs {
lift(input: PortfolioLiftInput, options?: SB.CallOptions): SB.Call<PortfolioLiftOutput>
}Emits Portfolio.lifted.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
portfolio | Portfolio | required | The braked Portfolio. |
brake | Setting | required | The brake to lift. |
reason | text | required | Why the effects may resume. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
brake | Setting | required | The lifted brake, kept on record. |
portfolio | Portfolio | required | The Portfolio, its brake lifted. |
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
import { $ } from 'startup-builder'
const { brake, portfolio } = await $.Portfolio.lift({ portfolio: 'portfolio_zkvUnP8LwY', brake: 'setting_mfZPXxFQYD', reason: 'Example reason' })