Skip to main content
PATCH
/
v1
/
review_protocol
Update
curl --request PATCH \
  --url https://{defaultHost}/v1/review_protocol \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "review_protocol": {
    "reviews_enabled": true,
    "solicit_reviews": true
  }
}
'
{
  "id": "4e4610e9-6934-4f7f-baf3-c180fccddfaf",
  "object": "review_protocol",
  "reviews_enabled": true,
  "solicit_reviews": true,
  "solicit_reviews_after_days": 7,
  "created_at": 1767909767,
  "updated_at": 1767909767
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
review_protocol
object

Response

200 - application/json

Success

​
id
string | null

The UUID of the specific object.

​
object
string

A string describing the object type returned.

​
reviews_enabled
boolean

If set to true, reviews will be enabled globally for all products in the account. Individual products must also have reviews enabled for reviews to be shown.

​
solicit_reviews
boolean

If set to true, review solicitation emails will be sent to customers who have purchased products. Individual products must also have solicitation enabled.

​
solicit_reviews_after_days
integer

The number of days after an order is fulfilled that a review solicitation email will be sent to the customer.

​
created_at
integer | null

Time at which the object was created. Measured in seconds since the Unix epoch.

​
updated_at
integer | null

Time at which the object was last updated. Measured in seconds since the Unix epoch.