Skip to main content
POST
/
send-whatsapp
Send Document
curl --request POST \
  --url https://api.flowiq.live/send-whatsapp \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone_number": "+27123456789",
  "message_type": "document",
  "media_url": "https://example.com/invoice.pdf",
  "filename": "Invoice_2025.pdf",
  "caption": "Please find your invoice attached",
  "context_message_id": "wamid.HBgLMjc4MTIzNDU2NzgVAgASGBQzRUI..."
}
'
{
  "success": true,
  "message": "Message sent successfully",
  "data": {
    "message_id": "wamid.HBgLMjc4MTIzNDU2NzgVAgASGBQzRUI...",
    "recipient": "27123456789",
    "message_type": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.flowapt.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Basic Usage

curl -X POST "https://api.flowiq.live/send-whatsapp" \
  -H "Authorization: Bearer fiq_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "phone_number": "+27123456789",
    "message_type": "document",
    "media_url": "https://example.com/invoice.pdf",
    "filename": "Invoice_2025.pdf",
    "caption": "Please find your invoice attached"
  }'

​
Request Body

FieldTypeRequiredDescription
phone_numberstringYesRecipient phone number with country code
message_typestringYesMust be "document"
media_urlstringYesPublicly accessible URL to the document
filenamestringNoDisplay filename shown to the recipient
captionstringNoOptional caption
context_message_idstringNoWhatsApp message ID to reply to
Supported formats: PDF, DOC, DOCX, XLS, XLSX, PPT, PPTX.
{
  "phone_number": "+27123456789",
  "message_type": "document",
  "media_url": "https://example.com/invoice.pdf",
  "filename": "Invoice_2025.pdf",
  "caption": "Please find your invoice attached"
}

​
Response

​
Success (200)

{
  "success": true,
  "message": "Message sent successfully",
  "data": {
    "message_id": "wamid.HBgLMjc4MTIzNDU2NzgVAgASGBQzRUI...",
    "recipient": "27123456789",
    "message_type": "document"
  }
}

​
Error: Missing Required Field (400)

{
  "error": "Missing required field",
  "message": "media_url is required for media messages"
}

​
Integration Example

async function sendDocument(apiKey, phoneNumber, mediaUrl, filename, caption) {
  const response = await fetch(
    `https://api.flowiq.live/send-whatsapp`,
    {
      method: "POST",
      headers: {
        Authorization: `Bearer ${apiKey}`,
        "Content-Type": "application/json",
      },
      body: JSON.stringify({ phone_number: phoneNumber, message_type: "document", media_url: mediaUrl, filename, caption }),
    }
  );
  const data = await response.json();
  if (!response.ok) throw new Error(data.message);
  return data;
}

Media URLs

Ensure the document URL is publicly accessible. The API needs to download the file before uploading to Meta.

Authorizations

​
Authorization
string
header
required

Bearer token for authentication. Format: Bearer YOUR_BEARER_TOKEN

Body

application/json
​
phone_number
string
required

Recipient phone number with country code

Example:

"+27123456789"

​
message_type
enum<string>
required

Must be "document"

Available options:
document
Example:

"document"

​
media_url
string
required

Publicly accessible URL to the document file

Example:

"https://example.com/invoice.pdf"

​
filename
string

Display filename shown to the recipient

Example:

"Invoice_2025.pdf"

​
caption
string

Optional caption for the document

Example:

"Please find your invoice attached"

​
context_message_id
string

WhatsApp message ID to reply to

Example:

"wamid.HBgLMjc4MTIzNDU2NzgVAgASGBQzRUI..."

Response

Message sent successfully

​
success
boolean
Example:

true

​
message
string
Example:

"Message sent successfully"

​
data
object