Skip to main content
POST
Capture an NPS score (company-level or tool-specific)

Authorizations

Authorization
string
header
required

Company secret API key.

Body

application/json
score
number
required

NPS score 0-10 (0-6 detractor, 7-8 passive, 9-10 promoter)

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

9

npsToolId
string<ObjectId>

Optional NPS tool id. With it the capture is tool-specific; without it, company-level.

clientEmail
string<email>

Respondent email. Omit for an anonymous capture.

clientPhone
string

Respondent phone when email is not supplied.

anonymous
boolean

Whether the submission is anonymous (no client email stored).

responseChannel
string

Inbound response channel. Defaults to 'api'; a value provided here REPLACES 'api' (user-defined channel). Stored on the NPS.

Maximum string length: 48
Example:

"my-crm"

dispatchToken
string

Opaque invitation dispatch token echoed from the link (?dtoken=). Consumed to mark the outbound invitation responded; never persisted.

Maximum string length: 64
Example:

"a1b2c3d4-..."

Response

NPS created