Skip to content

by Startups.Studio

Growth Demand Budget

DemandBudget.update

PATCH /{namespace}/demand-budgets/{id}

Changes the given properties of a Demand Budget.

Noun: Demand Budget
Mode: do
Event: DemandBudget.updated

You, to your agent

Change the latest demand budget.

curl -X PATCH https://api.sb/ledgerlark.com/demand-budgets/demand_budget_1 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"amount":{"amount":400,"currency":"USD"}}'

import { $ } from 'startup-builder'

const demandBudget = await $.DemandBudget.update({ id: 'demand_budget_1', amount: { amount: 400, currency: 'USD' } })

npx startup-builder do DemandBudget.update --json '{"id":"demand_budget_1","amount":{"amount":400,"currency":"USD"}}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.DemandBudget.update({ id: 'demand_budget_1', amount: { amount: 400, currency: 'USD' } })"
  }
}

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

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Demand Budget.
`amount`	`money`		The monthly spend it funds; zero is the default.
`tier`	`string`		One of `$0`, `$100`, `$1k`, `$10k` or `$100k`: the highest tier at or below the amount, whose Play mix it buys.
`target`	`string`		The Metric value the spend must reach, such as cost per first Order under $40.
`stopRule`	`string`		The reading that closes the budget, such as acquisition cost above margin for two weeks.
`until`	`date`		The last day the budget runs before its Decision is read.

Outputs

Output	Type	Required	Description
`demandBudget`	Demand Budget	required	The Demand Budget.

Effects

Emits DemandBudget.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.	DemandBudget.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`.

DemandBudget.list

Previous Page

Enrollment

Next Page