Skip to main content
POST

Formats and Size Limits

URL Requirements

The URL must be publicly accessible via HTTPS, must not require authentication, and must point directly to the file (not to an HTML page).

Common Errors

  • INVALID_MEDIA_URL - The image URL is invalid or inaccessible
  • MEDIA_TOO_LARGE - The image exceeds the 5MB limit
  • UNSUPPORTED_MEDIA_TYPE - The image format is not supported

Use Cases

  • Sharing product photos
  • Sending visual menus
  • Showing visual instructions
  • Sharing screenshots

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"