Capture an NPS score
Submits an NPS score (0 to 10) for the caller company. Provide npsToolId to attach the score to a specific NPS tool; omit it for a company-level score. Optionally include the respondent email, or mark the submission anonymous. The detractor (0 to 6) / passive (7 to 8) / promoter (9 to 10) category is derived from the score by Woku.
Authorizations
Company API key. Obtain this from your Woku dashboard under Settings > API Keys. The same key used for the v0 endpoints.
Body
NPS score. 0 to 6 detractor, 7 to 8 passive, 9 to 10 promoter.
0 <= x <= 109
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).
48Optional NPS tool id. With it the score is attached to that tool; without it the score is company-level.
^[0-9a-fA-F]{24}$"507f1f77bcf86cd799439011"
Respondent email. Omit (or set anonymous) for an anonymous score.
"customer@example.com"
When true, no respondent email is stored.