Skip to main content
POST
/
wokus
/
create-textnote
curl --request POST \ --url https://clientapi.woku.app/wokus/create-textnote \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "wokuId": "507f1f77bcf86cd799439011", "qualification": 5, "description": "Excellent service! The staff was very helpful and friendly." } '
{
  "_id": "507f1f77bcf86cd799439018",
  "wokuId": "507f1f77bcf86cd799439011",
  "qualification": {
    "qualification": 5
  },
  "description": "Excellent service!",
  "anonymous": false,
  "clientId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Company API key. Obtain this from your Woku dashboard under Settings > API Keys.

Body

application/json
​
wokuId
string<objectid>
required

MongoDB ObjectId of the woku to add the review to

Example:

"507f1f77bcf86cd799439011"

​
qualification
integer
required

Star rating from 1 to 5

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

5

​
description
string
required

Text content of the review (max 3000 characters)

Maximum string length: 3000
Example:

"Excellent service! The staff was very helpful and friendly."

​
clientEmail
string<email>

Email address of the reviewer

Example:

"[email protected]"

​
clientPhone
string

Phone number of the reviewer

Example:

"56912345678"

​
anonymous
boolean
default:false

Whether the review should be anonymous

Example:

false

Response

Textnote created successfully

​
_id
string<objectid>

Unique identifier of the textnote

Example:

"507f1f77bcf86cd799439018"

​
wokuId
string<objectid>

Woku ID the textnote belongs to

Example:

"507f1f77bcf86cd799439011"

​
qualification
object
​
description
string

Text content of the review

Example:

"Excellent service!"

​
anonymous
boolean
Example:

false

​
clientId
string<objectid>
​
createdAt
string<date-time>
​
updatedAt
string<date-time>