Update State and Bid of Existing Keywords

Description

You can update current state and bid of existing keywords using this method.

URL: ​PUT/api/v1/keywords

Query Parameters

ParameterNotesTypeRequired Possible Values
keywordIdID of the keywordintegerYUnique numeric identifier
stateState of the keywordstringNState values can be: enabled, paused, archived
bidMaximum cost per click for the keyworddoubleNValid bid value.
  • Note: Minimum bid amount is:
    • $0.30 for keyword bidding campaigns
    • $0.20 limit is for Auto bid campaigns
    • $1 for Sponsored Brands campaigns
    • $1.30 for Sponsored Videos campaigns
Bid amount will be restricted to first two decimal places for advertisers.
Any decimal digit beyond the first 2 digits will be truncated without rounding off.
For a keyword bid, maximum bid amount should be less than or equal to $100.

Sample Request

curl -X POST \
'https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v1/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": 345, "state": "enabled", "bid": .70 }'

Response

Element DescriptionType
codeThe response code can have following values: success, failurestring
detailsDetails of the error if value of response code is failurestring
keywordIdID of the keywordinteger

Sample Response

[ { "code": "success", "details": " ", " keywordId": 600003 }
]