Skip to main content
POST
Create a text review for a Woku

Authorizations

Authorization
string
header
required

Company API key. Obtain this from your Woku dashboard under Settings > API Keys. The same key used for the v0 endpoints.

Path Parameters

wokuId
string
required

MongoDB ObjectId of the Woku.

Pattern: ^[0-9a-fA-F]{24}$

Body

application/json
qualification
enum<integer>
required
Available options:
1,
2,
3,
4,
5
Example:

5

description
string
required
Maximum string length: 3000
Example:

"Excellent service! The staff was very helpful."

responseChannel
string

Optional inbound response channel: whatsapp | email | review-app | widget-web | mobile-sdk | api, or a user-defined string. Defaults to 'api' when omitted; any value provided here REPLACES it and is stored verbatim (user-defined channel).

Maximum string length: 48
clientEmail
string<email>
clientPhone
integer

Reviewer phone number.

anonymous
boolean
default:false

Response

Textnote created