POST
Explain money held for review

Authorizations

Authorization
string
header
required

The user's token from a completed sign-in. The program and environment come from the token.

Path Parameters

customerId
string
required

The customer

Minimum string length: 1
reviewId
string
required

The review. It must belong to customerId.

Minimum string length: 1

Query Parameters

programId
string

The program to act on. Ignored for customer tokens.

sandbox
enum<string>

Only when the token carries no sandbox claim: which environment to act in.

Available options:
true,
false

Body

application/json
note
string | null

Why the money is what it is, in the customer's words. Leave it out (or empty) only to add documents to a review that already has the reason

Maximum string length: 2000
documents
string[]

S3 URLs of files the customer uploaded for this review, in their own folder

Maximum array length: 10

Response

The review, with what was just sent

success
enum<boolean>
required
Available options:
true
message
string
required

What happened, for display

data
object
required