Delete a Budget Order
Soft-deletes a budget order by its unique identifier.
URL
DELETE https://api.ads.apple.com/v1/shared-budgets/{id}Path Parameters
| Name | Type | Description |
|---|---|---|
id Required | string |
Response Codes
| Status | Reason | Type | Description |
|---|---|---|---|
| 200 | OK Content-Type: application/json | Response | |
| 400 | Bad Request Content-Type: application/json | ErrorResponse | |
| 401 | Unauthorized Content-Type: application/json | ErrorResponse | |
| 403 | Forbidden Content-Type: application/json | ErrorResponse | |
| 404 | Not Found Content-Type: application/json | ErrorResponse | |
| 429 | Too Many Requests Content-Type: application/json | ErrorResponse | |
| 500 | Internal Server Error Content-Type: application/json | ErrorResponse |
Discussion
This endpoint soft-deletes the specified budget order. The system marks the record deleted: true, and it’s no longer available for assignment to campaigns. You must remove all campaign assignments before you can delete a budget order.
Check deletion restrictions
Deletion returns a 400 Bad Request in the following cases:
The budget order has been canceled (status reason
CANCELED).The budget order has completed or expired (status reason
SCHEDULE_EXPIRED).The budget order is exhausted (status reason
EXHAUSTED).The budget order has already started (start time is in the past).
The budget order has campaigns currently assigned to it. Remove all campaign assignments first.
Deleting an already-deleted budget order returns a 404 Not Found.
Deletion has different implications depending on what you’re trying to do next:
Scenario | Behavior |
|---|---|
Campaign assignments | You must remove them before deletion is allowed. A budget order with active campaign assignments cannot be deleted. |
Querying deleted budget orders | Include |
Restoration | The API cannot restore soft-deleted budget orders. |
Re-creation | Create a new budget order with the same name and parameters if needed. |