Skip to main content
POST
Send the CES survey by email or WhatsApp

Authorizations

Authorization
string
header
required

Company secret API key.

Headers

X-Woku-Idempotency-Key
string

Client-generated key to make a send safe to retry. A retry with the same key returns the original result instead of dispatching again.

Body

application/json
channel
enum<string>
required

Delivery channel for the invitations

Available options:
email,
whatsapp
Example:

"whatsapp"

recipients
string[]
required

Recipients: email addresses for the email channel, phone numbers (digits, country code included, e.g. 56912345678) for whatsapp

Maximum array length: 100
Example:
cesToolId
string<ObjectId>
required

CES tool to survey for (always required: always custom).

language
enum<string>

Language of the invitation template

Available options:
es,
en
Example:

"es"

Response

Per-recipient dispatch summary

channel
enum<string>
required
Available options:
email,
whatsapp
accepted
string[]
required

Recipients whose invitation was dispatched (or queued)

rejected
object[]
required

Recipients whose invitation was not dispatched, with reason