Contents

Update a Budget Order

Updates mutable fields of an existing budget order by its unique identifier.

URL

PUT https://api.ads.apple.com/v1/shared-budgets/{id}

Path Parameters

NameTypeDescription
id Requiredstring

Response Codes

StatusReasonTypeDescription
200OK
Content-Type: application/json
SharedBudgetResponse

Successful operation. Returns SharedBudgetResponse (result: SharedBudget).

400Bad Request
Content-Type: application/json
ErrorResponse

Bad Request. Returns ErrorResponse.

401Unauthorized
Content-Type: application/json
ErrorResponse

Unauthorized.

403Forbidden
Content-Type: application/json
ErrorResponse

Forbidden.

404Not Found
Content-Type: application/json
ErrorResponse

Resource not found. Returns ErrorResponse.

429Too Many Requests
Content-Type: application/json
ErrorResponse

Rate Limit Exceeded. See Applying Rate Limits.

500Internal Server Error
Content-Type: application/json
ErrorResponse

Internal Server Error. Returns ErrorResponse.

Discussion

This endpoint updates one or more mutable fields on an existing budget order. Only include the fields you want to change. Fields you don’t include remain unchanged. Pass the budget order id as a URL path parameter. You don’t need to include it in the request body. End date changes on active budget orders can only shorten the period, not extend it, except that you can set endTime to null to remove the expiration date entirely and make the budget open-ended.

Payload Examples

See Also