Skip to main content
POST
Captura una puntuacion NPS

Autorizaciones

Authorization
string
header
requerido

Clave de API de la empresa. Obtenla desde tu panel de Woku en Configuracion > API Keys. La misma clave usada para los endpoints v0.

Cuerpo

application/json
score
integer
requerido

Puntaje NPS. 0 a 6 detractor, 7 a 8 pasivo, 9 a 10 promotor.

Rango requerido: 0 <= x <= 10
Ejemplo:

9

responseChannel
string

Canal de respuesta entrante opcional. El valor por defecto es 'api'; un valor indicado aqui lo REEMPLAZA (canal definido por el usuario).

Maximum string length: 48
npsToolId
string

Id opcional de herramienta NPS. Con el, el puntaje se asocia a esa herramienta; sin el, el puntaje es a nivel de empresa.

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

"507f1f77bcf86cd799439011"

clientEmail
string<email>

Correo del encuestado. Omitelo (o marcalo como anonimo) para un puntaje anonimo.

Ejemplo:

"customer@example.com"

anonymous
boolean
predeterminado:false

Cuando es true, no se almacena ningun correo del encuestado.

Respuesta

Puntuacion NPS creada

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

"507f1f77bcf86cd799439abc"

nps
object

El documento NPS creado.