Update a Keyword
Update a keyword’s bid amount or status to optimize spend and control delivery for that term.
URL
PUT https://api.ads.apple.com/v1/keywords/{id}Path Parameters
| Name | Type | Description |
|---|---|---|
id Required | string |
Header Parameters
| Name | Type | Description |
|---|---|---|
X-Ap-Context Required | string |
Response Codes
| Status | Reason | Type | Description |
|---|---|---|---|
| 200 | OK Content-Type: application/json | KeywordResponse | |
| 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 updates an existing keyword. Only fields included in the request body are modified. Omitted fields retain their current values. The KeywordUpdate schema is intentionally narrow. Only bid and status are accepted. Attempting to update a deleted keyword returns 404 Not Found. This differs from Get a Keyword, which doesn’t return 404 for a deleted keyword. It returns the keyword with deleted: true instead.
On update, bid must be a valid Money object. Passing null returns an error, unlike Create a Keyword, where omitting bid or passing null defaults the keyword to the ad group’s bid strategy. See Managing Keywords and Negative Keywords for the full explanation.