Skip to main content


Note: This method is only available for select partners who have been approved for the eBay priority strategy program. For information about how to request access to this program, refer to Priority Strategy Access Requests in the Promoted Listings Playbook. To determine if a seller qualifies for priority strategy, use the getAdvertisingEligibility method in Account API.
This method updates the statuses of existing negative keywords, in bulk.

Specify the negativeKeywordId and negativeKeywordStatus in the request body.


Resource URI


This method is supported in Sandbox environment. To access the endpoint, just replace the root URI with

URI parameters

This method has no URI parameters.

HTTP request headers

All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.

The table below shows additional HTTP request headers that are either required, conditionally required, or strongly recommended for this method. Other standard HTTP request headers- opens rest request components page (not in this table) can also be used, but they are optional.

Content-TypestringThis header indicates the format of the request body provided by the client. Its value should be set to application/json.

For more information, refer to HTTP request headers.

Occurrence: Required

OAuth scope

This request requires an access token created with the authorization code grant flow, using one or more scopes from the following list (please check your Application Keys page for a list of OAuth scopes available to your application):

See OAuth access tokens for more information.

Request payload

Copy complete valid JSON to clipboard

Request fields

Input container/fieldTypeDescription
requestsarray of UpdateNegativeKeywordIdRequest

An array to update the statuses of one or more existing negative keywords.

Occurrence: Required


A unique eBay-assigned ID for a negative keyword. This keyword ID will be generated for each successfully created negative keyword.

Use the getNegativeKeywords method to retrieve negative keyword IDs.

Occurrence: Required


A field that defines the status of the negative keyword.

See NegativeKeywordStatusEnum for supported values.

Occurrence: Optional


HTTP response headers

This call has no response headers.

Response payload

Response fields

Output container/fieldTypeDescription
responsesarray of UpdateNegativeKeywordResponse

A list of negative keywords that have been processed from the bulk request.

Occurrence: Conditional

responses.errorsarray of ErrorDetailV3

A container that will be returned if there are one or more issues associated with modifying the corresponding negative keyword.

Occurrence: Conditional


The category type for this error or warning. It takes an ErrorCategory object which can have one of three values:

  • Application: Indicates an exception or error occurred in the application code or at runtime. Examples include catching an exception in a service's business logic, system failures, or request errors from a dependency.
  • Business: Used when your service or a dependent service refused to continue processing on the resource because of a business rule violation such as "Seller does not ship item to Antarctica" or "Buyer ineligible to purchase an alcoholic item". Business errors are not syntactical input errors.
  • Request: Used when there is anything wrong with the request, such as authentication, syntactical errors, rate limiting or missing headers, bad HTTP header values, and so on.

Occurrence: Conditional


Name of the domain containing the service or application.

Occurrence: Conditional


A positive integer that uniquely identifies the specific error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms.

Occurrence: Conditional

responses.errors.inputRefIdsarray of string

Identifies specific request elements associated with the error, if any. inputRefId's response is format specific. For JSON, use JSONPath notation.

Occurrence: Conditional


An expanded version of message that should be around 100-200 characters long, but is not required to be such.

Occurrence: Conditional


An end user and app developer friendly device agnostic message. It explains what the error or warning is, and how to fix it (in a general sense). Its value is at most 50 characters long. If applicable, the value is localized in the end user's requested locale.

Occurrence: Conditional

responses.errors.outputRefIdsarray of string

Identifies specific response elements associated with the error, if any. Path format is the same as inputRefId.

Occurrence: Conditional

responses.errors.parametersarray of ErrorParameterV3

This optional complex field type contains a list of one or more context-specific ErrorParameter objects, with each item in the list entry being a parameter (or input field name) that caused an error condition. Each ErrorParameter object consists of two fields, a name and a value.

Occurrence: Conditional


Name of the entity that threw the error.

Occurrence: Conditional


A description of the error.

Occurrence: Conditional


Name of the domain's subsystem or subdivision. For example, checkout is a subdomain in the buying domain.

Occurrence: Conditional


A unique eBay-assigned ID for a negative keyword. This keyword ID will be generated for each successfully created negative keyword.

Occurrence: Conditional


An HTTP status code that indicates the success or failure of updating that negative keyword.

Occurrence: Conditional

HTTP status codes

This call can return one of the following HTTP status codes. For an overview of the status codes, see HTTP status codes in Using eBay RESTful APIs.

207Multi Status
400Bad Request
409Business error
500Internal Server error

Error codes

For more on errors, plus the codes of other common errors, see Handling errors.

35001API_MARKETINGAPPLICATIONThere was a problem with an eBay internal system or process. Contact eBay Developer Technical Support for assistance.
35089API_MARKETINGBUSINESSWe are currently testing a premium ads product with a small invite-only group. We will share more information when we are ready to expand.
36337API_MARKETINGREQUESTYou have exceeded the maximum number of negative keyword requests in a bulk. Only {maxSupportedNegativeKeywordRequestNumberInBulk} Ids are supported per call.
36340API_MARKETINGREQUESTNo negative keyword found for negative keyword id {negativeKeywordId}.
36341API_MARKETINGREQUESTThere are duplicate negative keyword Ids in this request. You must remove the duplicate(s).
36342API_MARKETINGREQUESTNegativeKeywordStatus is missing or invalid. It is required for update.
36343API_MARKETINGREQUESTNegative keyword with negative keyword id {negativeKeywordId} is already archived and cannot be updated.
36348API_MARKETINGREQUESTNegative keyword id 'negativeKeywordId' is required.
36349API_MARKETINGREQUESTThe 'negativeKeywordId' is invalid.


This call has no warnings.


New to making API calls? Please see Making a Call.

Note: Identifiers, such as order IDs or user IDs, and personal data in these samples might be anonymized or may no longer be active on eBay. If necessary, substitute current, relevant eBay data in your requests.

Sample 1: Update Negative Keywords in Bulk

This example updates the statuses for negative keywords, in bulk, for a Promoted Listings priority strategy ad campaign.


The inputs for this sample are the negativeKeywordId for the negative keyword(s) that shall be updated, along with the updated negativeKeywordStatus for the associated negative keyword(s), both passed in the request body.



If the call is successful, the details for the updated negative keyword(s) are returned.

Got thoughts? Click the feedback button – your insights help us improve!