Create Campaign Negative Keywords
Creates negative keywords for a campaign.
URL
POST https://api.searchads.apple.com/api/v5/campaigns/{campaignId}/negativekeywords/bulkPath Parameters
| Name | Type | Description |
|---|---|---|
campaignId Required | int64 | The unique identifier for the campaign. |
Response Codes
| Status | Reason | Type | Description |
|---|---|---|---|
| 200 | OK Content-Type: application/json | NegativeKeywordListResponse | If the call succeeds, the API returns a list of NegativeKeyword objects in the response payload with an HTTP status code of |
| 400 | Bad Request Content-Type: application/json | ApiErrorResponse | |
| 401 | Unauthorized Content-Type: application/json | ApiErrorResponse | |
| 403 | Forbidden Content-Type: application/json | ApiErrorResponse | |
| 404 | Not Found Content-Type: application/json | ApiErrorResponse | |
| 429 | Content-Type: application/json | ApiErrorResponse | |
| 500 | Internal Server Error Content-Type: application/json | ApiErrorResponse |
Overview
400: An invalid query or missing required parameters.
401: An unauthenticated call fails to get the requested response.
403: Insufficient rights to the resource.
404: The API can’t locate the resource.
429: The API calls exceed rate-limit thresholds. See the Rate Limits subsection of Calling the Apple Ads API.
500: The Apple Ads server is temporarily down or unreachable. The request may be valid, but you need to retry it later.
Discussion
Negative keywords prevent your ad from showing up in App Store searches. Negative keywords can belong to a campaign or an ad group.
To create campaign negative keywords, use the associated campaignId in the URI.
Payload example: Create campaign negative keywords
HTTP Body
The request body that includes negative keyword details.