Skip to main content
POST
Button text: WhatsApp displays the button with predefined text in the user’s language, since this button’s text cannot be customized. You can only set the message that goes with it in the text field.

​
Best Practices

Privacy: Always explain why you need the user’s contact information. Be transparent about how their data will be used.

​
Use Cases

  • Registering a new customer
  • Collecting details to follow up on a request
  • Confirming the user’s identity before continuing a process
  • Updating an existing customer’s contact information

Authorizations

​
Authorization
string
header
required

Basic authentication using Base64 encoded clientId:clientSecret

Path Parameters

​
botId
string
required

The unique identifier of the bot

Body

application/json

Message payload. The structure varies based on the message type.

​
type
enum<string>
required

Type of message to send

Available options:
text
Example:

"text"

​
userId
string
required

Unique identifier of the user receiving the message. Accepts either a phone number in E.164 format without the leading '+' (e.g. '593999999999') or a BSUID (Business-Scoped User ID, e.g. 'US.13491208655302741918') for users who have enabled phone number privacy in WhatsApp.

Example:

"593999999999"

​
text
string
required

Text content of the message

Example:

"Hello, this is a text message"

​
botId
string

Unique identifier of the bot sending the message

Example:

"BOT_ID"

Response

Message sent successfully

​
success
boolean
Example:

true

​
messageId
string
Example:

"msg_123456789"