Skip to main content
POST
/
v1
/
nps
Capture an NPS score
curl --request POST \
  --url https://clientapi.woku.app/v1/nps \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "score": 9,
  "npsToolId": "507f1f77bcf86cd799439011",
  "clientEmail": "customer@example.com",
  "anonymous": false
}
'
{
  "npsId": "507f1f77bcf86cd799439abc",
  "nps": {
    "_id": "<string>",
    "companyId": "<string>",
    "score": 9,
    "npsToolId": "<string>",
    "clientId": "<string>",
    "anonymous": true,
    "createdAt": "2023-11-07T05:31:56Z"
  }
}

Documentation Index

Fetch the complete documentation index at: https://woku.app/docs/llms.txt

Use this file to discover all available pages before exploring further.

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.

Body

application/json
​
score
integer
required

NPS score. 0–6 detractor, 7–8 passive, 9–10 promoter.

Required range: 0 <= x <= 10
Example:

9

​
npsToolId
string

Optional NPS tool id. With it the score is attached to that tool; without it the score is company-level.

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

"507f1f77bcf86cd799439011"

​
clientEmail
string<email>

Respondent email. Omit (or set anonymous) for an anonymous score.

Example:

"customer@example.com"

​
anonymous
boolean
default:false

When true, no respondent email is stored.

Response

NPS score created

​
npsId
string
Pattern: ^[0-9a-fA-F]{24}$
Example:

"507f1f77bcf86cd799439abc"

​
nps
object

The created NPS document.