Contents

Create a Keyword

Create a new keyword in an ad group, setting the match type and optional bid amount.

URL

POST https://api.ads.apple.com/v1/keywords

Header Parameters

NameTypeDescription
X-Ap-Context Requiredstring

Response Codes

StatusReasonTypeDescription
200OK
Content-Type: application/json
KeywordResponse
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 creates one keyword per request. To create many keywords in a single call, use Bulk Create Keywords.

Creates a keyword in an ad group. Each keyword belongs to an ad group via adGroupId, which is required at creation and immutable afterward. The text field is the search term itself and is also immutable after creation. To change a keyword’s text, delete it and create a new one.

Omitting bid or passing null on create defaults the keyword to the ad group’s bid strategy. This differs from Update a Keyword, where null isn’t accepted for bid. See Managing Keywords and Negative Keywords for the full explanation.

Payload Examples

See Also