Skip to main content
POST
Review a booking, in either direction

Authorizations

x-api-key
string
header
required

API key minted in the MarketBox dashboard. Scope is restricted to the projects you select at creation time. Every route needs the key's standard API access (*) except POST /v1/projects/{projectId}/events, which needs events:write; a key without * is refused with 403 CAPABILITY_NOT_GRANTED.

Path Parameters

projectId
string
required

The project (tenant) that owns the resource. Every resource in this API is scoped to a project, and your API key is restricted to the projects it was issued for — a project outside that scope returns 403.

Minimum string length: 1
Example:

"prj_01kv60qgnef2kt3pvqgwmkbzfr"

bookingId
string
required

The booking — one scheduled unit of service occupying supplier time.

Minimum string length: 1
Example:

"bk_01kv7q41n2hbqxwm03ymn7bxl9"

Body

application/json

Review data

direction
enum<string>
required

Which way the review points. CLIENT_TO_SUPPLIER is the client rating the supplier; SUPPLIER_TO_CLIENT is the supplier rating the client.

Available options:
CLIENT_TO_SUPPLIER,
SUPPLIER_TO_CLIENT
Example:

"CLIENT_TO_SUPPLIER"

ratingStars
integer
required

Whole-star rating from 1 to 5.

Required range: 1 <= x <= 5
Example:

5

reviewText
string

Optional free-text comment, up to 5000 characters.

Maximum string length: 5000
Example:

"Turned up on time and was a pleasure to work with."

Response

Review created

data
object
required