Skip to main content
POST
Typescript (SDK)

Authorizations

Authorization
string
header
required

API key in the format: Bearer {api_token}

Body

application/json
product
string
required

Product ID (prefix_id) the review is for

rating
integer
required

Star rating, 1-5

content
string
required

Review body

customer
string | null

Customer ID (prefix_id), optional

customer_name
string | null

Display name (required when no customer)

Response

Review created

id
string
required
object
string
required
rating
integer
required
customer_name
string | null
required
content
string | null
required
created_at
string<date-time>
required
customer_image_url
string | null
required