Change Keyword Status

Change keyword(s) status.

Resource URL

Newegg.com: https://api.newegg.com/marketplace/sponsoredmgmt/campaign/keyword/changestatus?sellerid={sellerid}

Note: Please make sure your request URL is all in lower case (except for Seller ID) and cannot contain any blank spaces or line breaks.

Parameters

Name Required? Description
sellerid Yes Your seller ID on Newegg Marketplace

Resource Information

HTTP Method Authentication? Request Formats Response Formats Rate Limited?
POST Required Json Json 1000 request per hour

Request Body

Attribute Required? Format Description
campaignNumber Yes Integer The identifier of the campaign
groupNumber Yes Integer The identifier of the group
keywordList keyword Yes String The keyword text
activeStatus Yes Enum Available values:

  • Active
  • Inactive
bid No Decimal Bid associated with this keyword. Applicable to biddable match types only
matchType Yes Integer The type of match

Available values:

  • 0: Exact
  • 1: Broad
  • 6: Phrase

Example: Json, Request

POST https://api.newegg.com/marketplace/sponsoredmgmt/campaign/keyword/changestatus?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json

{
  "campaignNumber": 619872,
  "groupNumber": 619873,
  "keywordList": [
    {
      "keyword": "pc cable management",
      "activeStatus": "Inactive",
      "bid": null,
      "matchType": 0
    }
  ]
}

Response Body

Attribute
Format
Description
msg String Return message
biz code Integer Available values:

  • 022: update keywords success
  • 400: has parameter valid question, please check request
  • 008: campaign name already exists, update campaign name fail, repeated campaign:[ Campaign-xx]

Example: Json, Response

{
  "header": [
    {
      "msg": "update keywords success",
      "bizCode": "022"
    }
  ]
}

Last updated: June 29, 2022