Skip to main content
POST
Capture an NPS score

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 to 6 detractor, 7 to 8 passive, 9 to 10 promoter.

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

9

responseChannel
string

Optional inbound response channel: whatsapp | email | review-app | widget-web | mobile-sdk | api, or a user-defined string. Defaults to 'api' when omitted; any value provided here REPLACES it and is stored verbatim (user-defined channel).

Maximum string length: 48
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.