Cancel Sponsored Brands Campaign Review
Cancel a review for a Sponsored Brands campaign using PUT operation mentioned below
Note:
- You can cancel a review for campaign when the reviewStatus is “pending”/ “in-progress”
- When a review is cancelled, its “reviewStatus” will be changed to “cancelled”
- A review cannot be cancelled if the reviewStatus is complete
URL: PUT/api/v1/review
Request Parameters
| Parameter | Notes | Type | Required | Possible Values |
|---|---|---|---|---|
| adGroupId | The ID of the ad group | integer | Y | A valid ad group ID |
| campaignId | The type of the campaign | integer | Y | A valid campaign ID |
| reviewId | The ID of the review that needs to be updated | integer | Y | A valid review ID |
Headers
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 |
Sample Request
curl -X PUT \'
https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v1/review'\ --header 'accept: application/json' \ --header 'Authorization: Bearer <auth_token>' \ --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 '{ "adGroupId": 300002, "campaignId": 500003, "reviewId": 100001 }'
Response
| Element | Description | Type |
|---|---|---|
| code | The response code can have following values: success, failure | string |
| details | Details of the error if value of response code is failure | string |
| reviewId | ID of the review for particular ad group | integer |
Sample Response
[ { "code": "success", "details": "", "reviewId": 500001 } { "code": "failure", "details": "review not found, "reviewId": 0 }
]
Updated about 2 months ago