Skip to main content
POST
/
wokus
/
create-woku
Create a woku with file url
curl --request POST \
  --url https://clientapi.woku.app/wokus/create-woku \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "Docker Training",
  "fileUrl": "https://ik.imagekit.io/dior7woku/woku-web-site/cta/5.webp?updatedAt=1765935599547",
  "folderSecondaryKey": "17614778-3",
  "parentFolderSecondaryKey": "parentFolder17614778-3",
  "clientEmail": "[email protected]",
  "clientPhone": 56982959776
}
'
{
  "_id": "65348875f3a876254aa82d5e",
  "description": "Docker Training",
  "createdBy": "653485cff3a876254aa82d0b",
  "companyId": "6534865cf3a876254aa82d26",
  "users": [
    "653485cff3a876254aa82d0b",
    "6541cc3f666483667c07dd92"
  ],
  "file": {
    "filename": "image",
    "type": "image",
    "url": "https://ik.imagekit.io/dior7woku/woku-web-site/cta/5.webp?updatedAt=1765935599547"
  },
  "qualifications": [],
  "textnotes": [],
  "voicemails": [],
  "folderId": "6546d641f6258948f2d34b95"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
description
string
required

The description cannot have fewer than 3 characters and cannot exceed a maximum of 140 characters.

Example:

"Docker Training"

​
fileUrl
string
required

This field must contain a public URL that includes an image or video file. For optimal performance when sending video, the mp4 format is preferred.

Example:

"https://ik.imagekit.io/dior7woku/woku-web-site/cta/5.webp?updatedAt=1765935599547"

​
folderSecondaryKey
string

This field is optional. Upon completing this field, the woku will be stored in the Company Folder that holds this folder secondary key.

Example:

"17614778-3"

​
parentFolderSecondaryKey
string

This field is optional. Upon completing this field, the woku Folder will be stored in the Company Folder that holds this folder secondary key. This field cannot be the same as folderSecondaryKey because a folder cannot contain itself.

Example:

"parentFolder17614778-3"

​
clientEmail
string

This field is optional. By completing this field, an email will be sent to the client inviting them to rate the woku.

Example:

"[email protected]"

​
clientPhone
number

This field is the phone number of the client.

Example:

56982959776

Response

201 - application/json

woku created successfully.

​
_id
string
required

woku ID

Example:

"65348875f3a876254aa82d5e"

​
description
string
required

woku description.

Example:

"Docker Training"

​
createdBy
string
required

User ID creator of the woku.

Example:

"653485cff3a876254aa82d0b"

​
companyId
string
required

Company ID to which the woku belongs.

Example:

"6534865cf3a876254aa82d26"

​
users
string[]
required

Users Ids who worked on the woku. This field can be an empty array.

Example:
[
  "653485cff3a876254aa82d0b",
  "6541cc3f666483667c07dd92"
]
​
file
object
required

Data of the file representing the woku.

Example:
{
  "filename": "image",
  "type": "image",
  "url": "https://ik.imagekit.io/dior7woku/woku-web-site/cta/5.webp?updatedAt=1765935599547"
}
​
qualifications
string[]
required

Array with the Qualifications received from the woku.

Example:
[]
​
textnotes
string[]
required

Array with the Textnotes received from the woku.

Example:
[]
​
voicemails
string[]
required

Array with the Voicemails received from the woku.

Example:
[]
​
folderId
string
required

Folder ID.

Example:

"6546d641f6258948f2d34b95"