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"
}{
"statusCode": 400,
"message": [
"description must be a string",
"fileUrl must be a valid URL"
],
"error": "Bad Request"
}{
"statusCode": 404,
"message": "Resource not found",
"error": "Not Found"
}Create a text review
Creates a new text review (textnote) for a woku. Includes a star rating (1-5) and text feedback. You can optionally associate a client email or phone number.
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"
}{
"statusCode": 400,
"message": [
"description must be a string",
"fileUrl must be a valid URL"
],
"error": "Bad Request"
}{
"statusCode": 404,
"message": "Resource not found",
"error": "Not Found"
}Authorizations
Company API key. Obtain this from your Woku dashboard under Settings > API Keys.
Body
MongoDB ObjectId of the woku to add the review to
"507f1f77bcf86cd799439011"
Star rating from 1 to 5
1 <= x <= 55
Text content of the review (max 3000 characters)
3000"Excellent service! The staff was very helpful and friendly."
Email address of the reviewer
"reviewer@example.com"
Phone number of the reviewer (including country code, no spaces or symbols)
56988887777
Whether the review should be anonymous
false
Response
Textnote created successfully
Unique identifier of the textnote
"507f1f77bcf86cd799439018"
Woku ID the textnote belongs to
"507f1f77bcf86cd799439011"
Show child attributes
Show child attributes
Text content of the review
"Excellent service!"
false