Skip to main content
POST

Path parameters

string
required
Unique identifier of the bot sending the message.

Body parameters

string
required
Message type. Must be "cta_url".
string
required
Message recipient. Accepts a phone number in E.164 format without the leading + (e.g. 593999999999) or a BSUID (e.g. US.13491208655302741918) for users who have enabled phone number privacy in WhatsApp. See Identifying the recipient.
string
required
Message header.
string
required
Message body.
string
required
Message footer.
object
required
Button configuration.

Response

boolean
true if the message was sent successfully.
string
Identifier of the sent message.

Best Practices

Secure URLs: Make sure URLs are HTTPS and provide clear, actionable button text.

Use Cases

  • Directing users to external websites
  • Linking to web applications
  • Sharing online resources
  • Redirecting to forms or registration pages