budget

Set the budget

Sets the budget amount, period, currency and alert threshold, and arms or disarms the Emergency Brake. All fields are optional; send at least one.

The brake is armed by default. While armed, spending past the budget pauses the affected campaigns and notifies the owner. Disarmed, spending past the budget pauses nothing (alerts still fire). Raising global_budget re-arms a brake that already fired this month, so the new amount gets the same protection.

Errors

  • 400 VALIDATION_ERROR: the body failed validation; details.issues[] names each field.
put/api/v1/budget

Request

  • Base URL: https://api.growomat.com
  • URL: https://api.growomat.com/api/v1/budget
  • Auth: HTTP bearer

Headers

X-Space-Idstring

The Space to work in, for example spc_8f3aK2. Omit it to use your personal Space. List your Spaces returns the ids. A Space that does not exist returns 404 SPACE_NOT_FOUND; one you are not a member of returns 403 NOT_A_MEMBER.

Request body

global_budgetnumber

The budget amount, read according to period. Must be positive.

period'daily' | 'monthly'

Whether global_budget is a daily or a monthly amount. Monthly is the product default.

currencystring

ISO 4217 currency code, for example EUR.

alert_threshold_percentnumber

Percent of the budget at which the "approaching the limit" warning is sent. Default 90.

emergency_brakeboolean

Arm (true) or disarm (false) the Emergency Brake. Armed by default. Disarmed, spending past the budget no longer pauses anything.

Response

OK. The result is in data. List responses also carry meta with nextCursor and total.

dataunknown required

Changes

No recorded changes to this operation across all 1 revision of this API.