PUT /ad_campaign/{campaign_id}/keyword/{keyword_id}
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 keywords using a campaign ID and keyword ID for an existing PLA campaign.
In the request, specify the campaign_id and keyword_id as path parameters.
Call the getCampaigns method to retrieve a list of current campaign IDs for a seller and call the getKeywords method to retrieve their keyword IDs.
Servers
- https://api.ebay.com{basePath}
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
keyword_id |
String | Yes |
A unique eBay-assigned ID that is generated when a keyword is created. |
campaign_id |
String | Yes |
A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
bid |
Object | No |
A complex type that describes the value of a monetary amount as represented by a global currency. |
bid.value |
String | No |
The monetary amount in the specified currency. |
bid.currency |
String | No |
The base currency applied to the value field to establish a monetary amount. |
keywordStatus |
String | No |
Include this field if you wish to change the status of the keyword. The status value specified here must be different than the keyword's current status. To confirm the current status of a keyword, you can use the getKeyword method. If the status of the ad is currently |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.