Skip to main content
POST

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 or group ID. Use recipient for BSUID sends.

Example:

"15551234567"

type
enum<string>
required

Type of WhatsApp message

Available options:
text,
image,
video,
audio,
document,
sticker,
location,
contacts,
interactive,
template,
reaction
recipient_type
enum<string>
default:individual

Recipient type. Use individual for 1:1, group for group messages. When group, to must be a Group ID obtained via the Groups API.

Available options:
individual,
group
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"

context
object

Reply context

text
object
image
object
video
object
audio
object
document
object
sticker
object
location
object
contacts
object[]
interactive
object
template
object
reaction
object

Response

Message sent successfully

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

"whatsapp"

contacts
object[]
required
messages
object[]
required