Bulk Delete Keywords
Soft-deletes multiple keywords in a single request.
URL
POST https://api.ads.apple.com/v1/keywords/bulk-deleteHeader Parameters
| Name | Type | Description |
|---|---|---|
X-AP-Context Required | string |
Response Codes
| Status | Reason | Type | Description |
|---|---|---|---|
| 200 | OK Content-Type: application/json | KeywordDeleteBulkResponse | |
| 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
Each item in items requires a correlationId, unique within the batch, and a data object with the id of the keyword to delete. The API processes each deletion independently.
When allowPartialSuccess: true is set in the request, this endpoint uses partial success semantics: if some items fail (for example, an already-deleted ID fails with ENTITY_NOT_FOUND), the API still processes the successful deletions. When omitted or false, any single item failure rejects the entire batch. The response includes a per-item result with each item’s correlationId and success status, with failed items reporting success: false. It doesn’t include the deleted keyword.
Deleted keywords are marked deleted: true and stop serving. To stop a keyword from serving temporarily, set status: PAUSED with the bulk update endpoint instead.