Skip to main content
POST
Send a woku review invitation by email or WhatsApp

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.

Path Parameters

id
string
required

Woku id

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

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.