reviews

Updates or cancels a review.

This endpoint allows to change the follow-up date of a review or mark the order as cancelled which will tell our system to not send an email if it hasn't already been sent.

put/reviews/{siteid}/{reviewid}

Request

Base URL
https://api.shopperapproved.com
Auth
none declared
TypeScript
https://skmtc.dev/shopperapproved/apis/shopper-approved-api/docs/reviews/:siteid/:reviewid/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

siteidinteger required

The Site ID you are trying to update a review for.

reviewidstring required

The review_id or order id you would like to update

Query parameters

xmlboolean

If true, this will return an XML tree instead of a JSON response.

Request body application/x-www-form-urlencoded

tokenstring required

Your API token.

followupstring

A YYYY-MM-DD formatted date string for the date you would like the follow-up email to be sent on. Required if cancel is not passed.

cancelinteger

This should be 1 if you want to cancel the review. Required if followup is not passed.

Response

Success - Your desired action was completed.

Changes

No recorded changes to this operation across all 1 revision of this API.