Contents

Create Ad Group Negative Keywords

Creates negative keywords in a specific ad group.

URL

POST https://api.searchads.apple.com/api/v5/campaigns/{campaignId}/adgroups/{adgroupId}/negativekeywords/bulk

Path Parameters

NameTypeDescription
adgroupId Requiredint64

The unique identifier for the ad group.

campaignId Requiredint64

The unique identifier for the campaign.

Response Codes

StatusReasonTypeDescription
200OK
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 200 (OK). If unsuccessful, the HTTP status code indicates the error with details in the error message.

400Bad Request
Content-Type: application/json
ApiErrorResponse

An invalid query or missing required parameters.

401Unauthorized
Content-Type: application/json
ApiErrorResponse

An unauthenticated call fails to get the requested response.

403Forbidden
Content-Type: application/json
ApiErrorResponse

Insufficient rights to the resource.

404Not Found
Content-Type: application/json
ApiErrorResponse

The API can’t locate the resource.

429
Content-Type: application/json
ApiErrorResponse

The API calls exceed rate-limit thresholds. See the Rate Limits subsection of Calling the Apple Ads API.

500Internal Server Error
Content-Type: application/json
ApiErrorResponse

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 ad group negative keywords, use the associated campaignId and adgroupId in the URI.

Payload example: Create ad group negative keywords

HTTP Body

The request body that includes negative keyword details.

See Also

Ad Group Negative Keywords Endpoints