Update Negative Keywords
Update current state and bid of existing negative keywords using PUT operation mentioned below.
URL: PUT /api/v1/negative_keywords
Query Parameters
| Parameter | Description | Type | Required | Possible Values |
|---|---|---|---|---|
| keywordId | The ID of the keyword | string | Y | A valid keyword ID |
| state | The current state of the negative keyword resource | string | Y | enabledpausedarchived |
Headers
| Header Name | Description | Required | Values |
|---|---|---|---|
| Authorization | The token will provide you the access to the API. It is same for all advertisers you access through the API. | Y | Please utilize the generated auth_token shared with you at the time of partner onboarding from the Getting Started Guide |
| WM_CONSUMER.ID | We will provide you the consumer ID to access the API. It is same for all advertisers you access through the API. | Y | Please use the generated ConsumerId shared with you at the time of partner onboarding. Refer to the Getting Started Guide for more information |
| WM_SEC.AUTH_SIGNATURE | Auth signature as an API key. | Y | Use the signature generator code from Getting Started Guide to generate this value |
| WM_SEC.KEY_VERSION | We will provide you with the KEY VERSION to access the API. It is same for all advertisers you access through the API. | Y | 1 |
| WM_CONSUMER.intimestamp | Timestamp for which the auth signature is generated. Use Unix epoch format for the timestamp. | Y | Use the signature generator code from Getting Started Guide to generate this value |
| Content-Type | Format of the message body | Y | application/json |
Sample Request
curl -X POST \
'https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v1/negative_keywords' \
--header 'Authorization: Bearer <auth_token>' \ --header 'accept: application/json' \
--header 'WM_SEC.AUTH_SIGNATURE: ***********' \
--header 'WM_SEC.KEY_VERSION: 1' \ --header 'WM_CONSUMER.ID: adfwe-v23-faasd2r-afs-asdfqeff' \
--header 'WM_CONSUMER.intimestamp: 1565309779' \
--header 'Content-Type: application/json' \
--data '{ "keywordId": 600001, "state": "paused" }'
Response
| Element | Description | Type |
|---|---|---|
| keywordId | ID of the keyword | integer |
| code | Details of the error if value of response code is failure | string |
| details | ID of the keyword | integer |
Sample Response
[ { "code": "success", "details": "", " keywordId ": 600001 }
]Updated 2 days ago
Did this page help you?