bulkUpdateNegativeKeyword: eBay Marketing API

POST/bulk_update_negative_keyword

Note: This method is only available for select partners who have been approved for the eBay Promoted Listings Advanced (PLA) program. For information about how to request access to this program, refer to Promoted Listings Advanced Access Requests in the Promoted Listings Playbook. To determine if a seller qualifies for PLA, 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.

Input

Resource URI

POST https://api.ebay.com/sell/marketing/v1/bulk_update_negative_keyword

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

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.

Header	Type	Description
Content-Type	string	This 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

Header

Type

Description

Content-Type

string

This 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):

https://api.ebay.com/oauth/api_scope/sell.marketing

See OAuth access tokens for more information.

Request payload

Copy complete valid JSON to clipboard

{ /* BulkUpdateNegativeKeywordRequest */

"requests" : [

{ /* UpdateNegativeKeywordIdRequest */

"negativeKeywordId" : "string",

"negativeKeywordStatus" : "NegativeKeywordStatusEnum : [ACTIVE,ARCHIVED]"

}

]

}

Request fields

Input container/field	Type	Description
requests	array of UpdateNegativeKeywordIdRequest	An array to update the statuses of one or more existing negative keywords. Occurrence: Required
requests.negativeKeywordId	string	A unique eBay-assigned ID for a negative keyword. This keyword ID will be generated for each successfully created negative keyword. Occurrence: Required
requests.negativeKeywordStatus	NegativeKeywordStatusEnum	A field that defines the status of the negative keyword. Occurrence: Optional

Input container/field

Type

Description

requests

array of UpdateNegativeKeywordIdRequest

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

Occurrence: Required

requests.negativeKeywordId

string

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

Occurrence: Required

requests.negativeKeywordStatus

NegativeKeywordStatusEnum

A field that defines the status of the negative keyword.

Occurrence: Optional

Output

HTTP response headers

This call has no response headers.

Response payload

Copy complete valid JSON to clipboard

{ /* BulkUpdateNegativeKeywordResponse */

"responses" : [

{ /* UpdateNegativeKeywordResponse */

"errors" : [

{ /* ErrorDetailV3 */

"category" : "string",

"domain" : "string",

"errorId" : "integer",

"inputRefIds" : [

"string"

"longMessage" : "string",

"message" : "string",

"outputRefIds" : [

"string"

"parameters" : [

{ /* ErrorParameterV3 */

"name" : "string",

"value" : "string"

}

"subdomain" : "string"

}

"negativeKeywordId" : "string",

"statusCode" : "integer"

}

]

}

Response fields

Output container/field	Type	Description
responses	array of UpdateNegativeKeywordResponse	A list of negative keywords that have been processed from the bulk request. Occurrence: Conditional
responses.errors	array of ErrorDetailV3	A container that will be returned if there are one or more issues associated with modifying the corresponding negative keyword. Occurrence: Conditional
responses.errors.category	string	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
responses.errors.domain	string	Name of the domain containing the service or application. Occurrence: Conditional
responses.errors.errorId	integer	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.inputRefIds	array 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
responses.errors.longMessage	string	An expanded version of message that should be around 100-200 characters long, but is not required to be such. Occurrence: Conditional
responses.errors.message	string	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.outputRefIds	array of string	Identifies specific response elements associated with the error, if any. Path format is the same as `inputRefId`. Occurrence: Conditional
responses.errors.parameters	array 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
responses.errors.parameters.name	string	Name of the entity that threw the error. Occurrence: Conditional
responses.errors.parameters.value	string	A description of the error. Occurrence: Conditional
responses.errors.subdomain	string	Name of the domain's subsystem or subdivision. For example, checkout is a subdomain in the buying domain. Occurrence: Conditional
responses.negativeKeywordId	string	A unique eBay-assigned ID for a negative keyword. This keyword ID will be generated for each successfully created negative keyword. Occurrence: Conditional
responses.statusCode	integer	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.

Status	Meaning
200	Success
207	Multi Status
400	Bad Request
403	Forbidden
409	Business error
500	Internal Server error

Error codes

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

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

Warnings

This call has no warnings.

Samples

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 Advanced (PLA) ad campaign.

Input

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.

POSThttps://api.ebay.com/sell/marketing/v1/bulk_update_negative_keyword

Output

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