Update a Budget Order
Updates an existing budget order.
URL
PUT https://api.searchads.apple.com/api/v5/budgetorders/{boId}Path Parameters
| Name | Type | Description |
|---|---|---|
boId Required | int64 | The unique identifier for the budget order. |
Response Codes
| Status | Reason | Type | Description |
|---|---|---|---|
| 200 | OK Content-Type: application/json | BudgetOrderInfoResponse | If the call succeeds, the API returns the BudgetOrderInfo object in the response payload with an HTTP status code of |
| 400 | Bad Request Content-Type: application/json | ApiErrorResponse | An invalid query or missing required parameters. |
| 401 | Unauthorized Content-Type: application/json | ApiErrorResponse | An unauthenticated call fails to get the requested response. |
| 403 | Forbidden Content-Type: application/json | ApiErrorResponse | Insufficient rights to the resource. |
| 404 | Not Found Content-Type: application/json | ApiErrorResponse | The API can’t locate the resource. |
| 429 | Content-Type: application/json | ApiErrorResponse | The API calls exceed rate-limit thresholds. See the Rate Limits subsection of Calling the Apple Ads API. |
| 500 | Internal Server Error Content-Type: application/json | ApiErrorResponse | The Apple Ads server is temporarily down or unreachable. The request may be valid, but you need to retry it later. |
Mentioned in
Discussion
Use this endpoint to modify an existing budget order. Use the id that returns in the Create a Budget Order call as a resource.
Payload example: Update a budget order
HTTP Body
The request body that includes the details of the budget order.