Skip to main content
PATCH
/
v1
/
reviews
/
{id}
/
unpublish
Unpublish
curl --request PATCH \
  --url https://{defaultHost}/v1/reviews/{id}/unpublish \
  --header 'Authorization: Bearer <token>'
{
  "id": "4d32b434-bea7-4e1e-aa0e-321b621ed0aa",
  "object": "review",
  "body": "Really enjoyed using this.",
  "status": "unpublished",
  "title": "Great Product",
  "stars": 4.5,
  "verified": false,
  "customer": "77da2e6a-a13f-4491-b648-29cd8ce936ef",
  "product": "936db93b-32f3-4d58-8cfd-2a19d5ee7f30",
  "purchase": null,
  "created_at": 1767909770,
  "updated_at": 1767909770
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

Response

200 - application/json

Success

​
id
string | null

The UUID of the specific object.

​
object
string

A string describing the object type returned.

​
title
string | null

The title of the review.

​
body
string | null

The content/body of the review.

​
stars
number<float> | null

The numerical rating provided in the review. Can be a decimal from 1.0 to 5.0.

​
status
string | null

The status of the review (e.g. in_review, published, unpublished).

​
verified
boolean

Indicates whether the reviewer has purchased the product (based on presence of a purchase).

​
customer

Expandable – The associated customer ID.

​
product

Expandable – The associated product ID.

​
purchase

Expandable – The associated purchase ID.

​
review_medias

Expandable – Property not returned unless expanded.

​
discarded_at
integer | null

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

​
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.