Skip to main content
POST
Captura una puntuación NPS (a nivel de empresa o específica de la herramienta)

Autorizaciones

Authorization
string
header
requerido

Clave API secreta de la empresa.

Cuerpo

application/json
score
number
requerido

Puntuación de NPS 0-10 (0-6 detractor, 7-8 pasivo, 9-10 promotor)

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

9

npsToolId
string<ObjectId>

Id opcional de la tool NPS. Con él, la captura es específica de la tool. Sin él, es a nivel de empresa.

clientEmail
string<email>

Correo electrónico del encuestado. Omitir para una captura anónima.

clientPhone
string

Teléfono del cliente cuando no se proporciona email.

anonymous
boolean

Si el envío es anónimo, no se almacena el email del cliente.

responseChannel
string

Canal de respuesta entrante. El valor predeterminado es 'api'; un valor proporcionado aquí REEMPLAZA 'api' (canal definido por el usuario). Se almacena en el NPS.

Maximum string length: 48
Ejemplo:

"my-crm"

dispatchToken
string

Token opaco de despacho de invitación reflejado desde el enlace (?dtoken=). Se consume para marcar que la invitación saliente fue respondida. Nunca se persiste.

Maximum string length: 64
Ejemplo:

"a1b2c3d4-..."

Respuesta

NPS creado