Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14126767600.8 KB

Updates a budget that sets spending thresholds for rendering activity.

patch/2023-10-12/farms/{farmId}/budgets/{budgetId}

Path parameters

farmIdstring required

The farm ID of the budget to update.

budgetIdstring required

The budget ID to update.

Headers

X-Amz-Client-Tokenstring

The unique token which the server uses to recognize retries of the same request.

Request body

displayNamestring
<p>The display name of the budget to update.</p> <important> <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important>
descriptionstring password
<p>The description of the budget to update.</p> <important> <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important>
status'ACTIVE' | 'INACTIVE'
<p>Updates the status of the budget.</p> <ul> <li> <p> <code>ACTIVE</code>–The budget is being evaluated.</p> </li> <li> <p> <code>INACTIVE</code>–The budget is inactive. This can include Expired, Canceled, or deleted Deleted statuses.</p> </li> </ul>
approximateDollarLimitnumber float

The dollar limit to update on the budget. Based on consumed usage.

Response

Success

UpdateBudgetResponse required