Skip to main content
POST
Reply to Review

Authorizations

Authorization
string
header
required

Bearer API key for server-to-server access. Session auth is also supported in first-party UI flows.

Path Parameters

reviewId
string
required

Body

application/json
reply
string

Seller reply to send to this review. Omit when generateWithAi is true.

Required string length: 1 - 500
generateWithAi
boolean
default:false

Generate a reply using the review context and organization brand voice. Uses AI credits.

submit
boolean
default:true

true submits the reply to the marketplace. With generateWithAi, false returns a draft without submitting.

instructions
string

Optional writing instructions for AI-generated replies. Requires generateWithAi.

Required string length: 1 - 2000
organizationId
string

Required for session auth. API keys already belong to one organization.

Required string length: 1 - 160

Response

The reply or draft result for this review.

ok
boolean
required
apiVersion
string
required
Allowed value: "developer_v1"
operationId
string
required
status
enum<string>
required
Available options:
accepted,
completed,
failed
warnings
string[]
required
recommendations
string[]
required
data
object
required
jobId
string
productId
string