Skip to main content
POST
Call ads.set_budget

Authorizations

Authorization
string
header
required

An API key minted at Settings › API & MCP. Send it as Authorization: Bearer <key>. A key carries its holder's own permissions, resolved on every call — revoking a membership closes the key's reach immediately. Keep it in an environment variable (GOOSY_API_KEY), never in a committed file.

Headers

x-request-id
string

Your own id for this request, echoed back and recorded on the audit trail. 1–128 characters from A–Z a–z 0–9 . _ : -, starting with a letter or digit; anything else is replaced by a generated id.

Maximum string length: 128

Body

application/json
campaign_id
string<uuid>

The campaign's id. Leave it out to use the campaign the person is looking at.

daily_budget_dollars
number

The daily amount in DOLLARS, e.g. 40 for $40 a day — never cents. Leave it out to keep the current amount.

starts_on
string

The first day, YYYY-MM-DD, only when the person names one. Leave it out to keep the current start.

Pattern: ^\d{4}-\d{2}-\d{2}$
ends_on
string

The last day, YYYY-MM-DD, only when the person names one. Leave it out to keep the current end.

Pattern: ^\d{4}-\d{2}-\d{2}$
run_until_paused
boolean

true only when the person wants no end date — the campaign then runs until they pause it.

ad_count
integer

How many ads the campaign should try, only when the person names a number. It draws nothing by itself.

workspace
string

Which workspace to run in — its slug. Omit to use your default. With more than one reachable workspace and no default, the call is refused and the choices are listed.

Minimum string length: 1

Response

The call was admitted and dispatched. ok says whether the tool succeeded — a refusal the tool itself produced is still a 200, exactly as it is a successful JSON-RPC result over MCP.

The tool ran and answered.

ok
boolean
required
daily_budget_cents
integer
required
Required range: x >= 0
total_cents
integer | null
required
Required range: x >= 0
starts_on
string | null
required
ends_on
string | null
required
ad_count
integer
required
Required range: x >= 0
workspace
string
required

The slug of the workspace this call ran in.

working_in
object
required

Which workspace this call ran in, and how that was decided. Present on every workspace-scoped result.