Skip to main content
POST
Send a marketing message

Authorizations

X-API-Key
string
header
required

Project API key for authentication. This is the recommended authentication method.

Get your API key from the Kapso dashboard under Integrations > API keys.

Path Parameters

phone_number_id
string
required

WhatsApp Business Phone Number ID

Body

application/json
messaging_product
enum<string>
required

Always "whatsapp"

Available options:
whatsapp
Example:

"whatsapp"

to
string
required

Recipient phone number. Use recipient for BSUID sends.

Example:

"15551234567"

type
enum<string>
required

Marketing messages must use a WhatsApp template.

Available options:
template
Example:

"template"

template
object
required
recipient_type
enum<string>
default:individual

Marketing messages are sent to individual recipients.

Available options:
individual
biz_opaque_callback_data
string

Arbitrary string for tracking (echoed in webhooks)

Maximum string length: 512
recipient
string

Recipient BSUID or parent BSUID. If to is also present, the phone number in to takes precedence.

Example:

"US.13491208655302741918"

Response

Message accepted

messaging_product
enum<string>
required
Available options:
whatsapp
Example:

"whatsapp"

contacts
object[]
required
messages
object[]
required