Skip to main content
Get started with FlowMod API. This guide assumes you already have a FlowMod instance set up at app.flowiq.live/flowmod.

​
Prerequisites

You need:
  • FlowMod instance name
  • API key
  • Connected WhatsApp (QR code scanned)

​
1. Check Connection Status

Verify your WhatsApp instance is connected: 
curl -X GET 'https://api.flowmod.ai/instance/YOUR_INSTANCE/connectionState' \
  -H 'Authorization: Bearer YOUR_API_KEY'

​
2. Send Text Message

curl -X POST 'https://api.flowmod.ai/message/sendText/YOUR_INSTANCE' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "number": "1234567890",
    "text": "Hello from FlowMod API!"
  }'

​
3. Send Media

curl -X POST 'https://api.flowmod.ai/message/sendMedia/YOUR_INSTANCE' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "number": "1234567890",
    "mediatype": "image",
    "media": "https://example.com/image.jpg",
    "caption": "Sent via API"
  }'

​
4. Set Up Webhooks

curl -X POST 'https://api.flowmod.ai/webhook/set/YOUR_INSTANCE' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "webhook": {
      "url": "https://your-app.com/webhook",
      "events": ["MESSAGES_UPSERT"]
    }
  }'

​
Next Steps

API Reference

Complete endpoint documentation

Group Management

Manage WhatsApp groups programmatically

Webhooks

Handle real-time events

Message Types

All supported message formats

​
Troubleshooting

  • Verify instance name and API key - Check connection status shows “open” - Ensure WhatsApp is connected via QR code
  • Use international format without + (e.g., 1234567890) - Verify recipient has WhatsApp - Check instance connection status