Contents

Delete a Keyword

Soft-delete a keyword by ID, setting its deleted field to true and stopping bids on that term.

URL

DELETE https://api.ads.apple.com/v1/keywords/{id}

Path Parameters

NameTypeDescription
id Requiredstring

Header Parameters

NameTypeDescription
X-Ap-Context Requiredstring

Response Codes

StatusReasonTypeDescription
200OK
Content-Type: application/json
Response
400Bad Request
Content-Type: application/json
ErrorResponse
401Unauthorized
Content-Type: application/json
ErrorResponse
403Forbidden
Content-Type: application/json
ErrorResponse
404Not Found
Content-Type: application/json
ErrorResponse
429Too Many Requests
Content-Type: application/json
ErrorResponse
500Internal Server Error
Content-Type: application/json
ErrorResponse

Discussion

This endpoint soft-deletes the keyword by setting its deleted field to true. The record remains queryable by including deleted=true in query filters. The operation returns HTTP 200 with an empty response body on success.

Deleting a keyword doesn’t affect the parent ad group or campaign. Only the keyword itself is removed. Other keywords in the same ad group continue to serve normally. If you want to temporarily stop bidding on a term without permanently removing it, pause the keyword using PUT /keywords/{id} with status: "PAUSED" instead.

The soft delete is reflected consistently across subsequent GET and PUT requests.

Constraint

Detail

Soft deletion

Deletion sets the keyword’s deleted field to true. The record remains queryable by including deleted=true in query filters.

Does not affect parent resources

Deletion doesn’t modify the parent ad group or campaign.

GET returns the deleted keyword

GET requests after deletion return the keyword with deleted: true, not a 404.

PUT returns 404 after deletion

PUT requests to update a deleted keyword return 404 Not Found.

Use PAUSED status to suspend temporarily

If you may need to reactivate the term, set status: "PAUSED" rather than deleting.

Payload Examples

See Also