Create a Budget Order
Creates a budget order in the context of your org ID.
URL
POST https://api.searchads.apple.com/api/v5/budgetordersResponse 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 call to create a budget order in the context of your orgId.
When you create a budget order through the API or Apple Ads, the system returns a budget order id. Use this id as a resource to update a budget order, or with the Get a Budget Order call to fetch assigned, completed, and canceled budget orders for your organization. Use Get all Budget Orders to return all budget orders in the context of your orgId.
Payload example: Create a budget order
HTTP Body
The request body that includes the details of the budget order.