Skip to main content
POST
Envia la encuesta CES por correo o WhatsApp

Autorizaciones

Authorization
string
header
requerido

Clave API secreta de la empresa.

Encabezados

X-Woku-Idempotency-Key
string

Clave generada por el cliente para hacer que un envío sea seguro para reintentar. Un reintento con la misma clave devuelve el resultado original en lugar de despachar de nuevo.

Cuerpo

application/json
channel
enum<string>
requerido

Canal de entrega para las invitaciones

Opciones disponibles:
email,
whatsapp
Ejemplo:

"whatsapp"

recipients
string[]
requerido

Destinatarios: direcciones de correo electrónico para el canal email, números de teléfono (dígitos, código de país incluido, p. ej. 56912345678) para whatsapp

Maximum array length: 100
Ejemplo:
cesToolId
string<ObjectId>
requerido

Herramienta CES para encuestar, siempre requerida: siempre personalizada.

language
enum<string>

Idioma de la plantilla de invitación

Opciones disponibles:
es,
en
Ejemplo:

"es"

Respuesta

Resumen de despacho por destinatario

channel
enum<string>
requerido
Opciones disponibles:
email,
whatsapp
accepted
string[]
requerido

Destinatarios cuya invitación fue despachada (o puesta en cola)

rejected
object[]
requerido

Destinatarios cuya invitación no fue despachada, con motivo