Skip to main content
POST
/
wokus
/
create-woku
curl --request POST \ --url https://clientapi.woku.app/wokus/create-woku \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "description": "Customer Service Experience - Store #123", "fileUrl": "https://cdn.example.com/images/product-image.jpg" } '
{
  "_id": "507f1f77bcf86cd799439011",
  "description": "Customer Service Experience - Store #123",
  "createdBy": "507f1f77bcf86cd799439012",
  "companyId": "507f1f77bcf86cd799439013",
  "folderId": "507f1f77bcf86cd799439014",
  "file": {
    "filename": "product-image.webp",
    "type": "image",
    "url": "https://cdn.woku.app/files/product-image.webp"
  },
  "qualifications": [
    {
      "_id": "507f1f77bcf86cd799439015",
      "qualification": 5,
      "createdBy": "<string>",
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ],
  "textnotes": [
    {
      "_id": "507f1f77bcf86cd799439016",
      "qualification": {
        "qualification": 5
      },
      "description": "Excellent service!",
      "anonymous": false,
      "feedbackType": "positive",
      "clientId": "<string>",
      "validated": true,
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ],
  "voicemails": [
    {
      "_id": "507f1f77bcf86cd799439017",
      "qualification": {
        "qualification": 4
      },
      "file": {
        "filename": "voicemail.mp4",
        "url": "<string>"
      },
      "transcription": "I had a great experience with your service...",
      "anonymous": false,
      "feedbackType": "positive",
      "clientId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ],
  "feedbacksSummary": "Customers generally praise the helpful staff and quick service...",
  "closed": false,
  "createdAt": "2026-01-20T10:30:00.000Z",
  "updatedAt": "2026-01-20T15:45:00.000Z"
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
description
string
required

Description of the woku (product, service, or experience being reviewed)

Minimum string length: 1
Example:

"Customer Service Experience - Store #123"

​
fileUrl
string<uri>
required

URL of an existing file (image or video) to associate with the woku

Example:

"https://cdn.example.com/images/product-image.jpg"

​
folderSecondaryKey
string

Secondary key identifier for the folder. If the folder doesn't exist, it will be created automatically.

Example:

"store-123"

​
parentFolderSecondaryKey
string

Secondary key identifier for the parent folder. Used to create folder hierarchies.

Example:

"region-north"

​
clientEmail
string<email>

Email address of the client. If provided, a review invitation email will be sent.

Example:

"[email protected]"

​
clientPhone
integer

Phone number of the client (including country code, no spaces or symbols). If provided, a WhatsApp review invitation will be sent.

Example:

56912345678

Response

Woku created successfully

​
_id
string<objectid>

Unique identifier of the woku

Example:

"507f1f77bcf86cd799439011"

​
description
string

Description of the woku

Example:

"Customer Service Experience - Store #123"

​
createdBy
string<objectid>

User ID who created the woku

Example:

"507f1f77bcf86cd799439012"

​
companyId
string<objectid>

Company ID the woku belongs to

Example:

"507f1f77bcf86cd799439013"

​
folderId
string<objectid>

Folder ID the woku is organized in

Example:

"507f1f77bcf86cd799439014"

​
file
object
​
qualifications
object[]

Array of star ratings

​
textnotes
object[]

Array of text reviews

​
voicemails
object[]

Array of voice reviews

​
feedbacksSummary
string

AI-generated summary of all feedback

Example:

"Customers generally praise the helpful staff and quick service..."

​
closed
boolean
default:false

Whether the woku is closed for new reviews

​
createdAt
string<date-time>

Creation timestamp

Example:

"2026-01-20T10:30:00.000Z"

​
updatedAt
string<date-time>

Last update timestamp

Example:

"2026-01-20T15:45:00.000Z"