Skip to main content
POST
Send text message

Authorizations

api-key
string
header
required

Body

application/json
from
string
required

WhatsApp id of the sender phone number

Minimum string length: 1
text
object
required

Text content of the message

to
string

Recipient phone number, digits only, including country code. Takes precedence over recipient when both are set

Minimum string length: 1
recipient
string

Recipient BSUID or parent BSUID, used instead of to when the phone number is not known

Minimum string length: 1

Response

Message sent successfully

id
string<uuid>
required

Id of the created message

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$