Skip to main content
POST
/
v1
/
nps
/
invitations
Send the NPS survey by email or WhatsApp
curl --request POST \
  --url https://clientapi.woku.app/v1/nps/invitations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "recipients": [
    "<string>"
  ],
  "npsToolId": "<string>"
}
'
{
  "accepted": [
    "<string>"
  ],
  "rejected": [
    {
      "recipient": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Company API key. Obtain this from your Woku dashboard under Settings > API Keys. The same key used for the v0 endpoints.

Body

application/json
​
channel
enum<string>
required

Delivery channel for the invitations.

Available options:
email,
whatsapp
​
recipients
string[]
required

Email addresses (email channel) or phone numbers with country code, digits only, e.g. 56912345678 (whatsapp channel).

Required array length: 1 - 100 elements
​
language
enum<string>

Language of the invitation template. Defaults to es.

Available options:
es,
en
​
npsToolId
string

NPS tool to survey for. Omit to send the company-level NPS survey.

Response

Per-recipient dispatch summary. Sends are asynchronous.

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

Recipients whose invitation was dispatched (or queued). Normalized: emails lowercased, phones digits only.

​
rejected
object[]

Recipients whose invitation was not dispatched, with the reason.