Skip to main content

Documentation Index

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

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

​
Step 1 — Create your account

Create your account at app.msgflash.com/signup. The account starts on the Free plan:
  • 1 instance
  • 20 outbound messages per month
  • 1 API key for testing
After email signup:
  • your account is not automatically logged in
  • you must first verify your email address
  • then return to /login

​
Step 2 — Connect WhatsApp

  1. Open Instances
  2. Create an instance
  3. Connect it with the QR code
  4. Wait for the connected status

​
Step 3 — Generate an API key

  1. Open API Keys
  2. Create a new key
  3. Copy it immediately
The Free plan now allows 1 test API key. The rest of the Free limits stay unchanged.
Format: 
msgf_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

​
Step 4 — Send your first message

curl -X POST https://srv.msgflash.com/api/v1/messages/send \
  -H "x-api-key: msgf_live_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "instanceId": "YOUR_INSTANCE_ID",
    "to": "+33612345678",
    "type": "text",
    "text": "Hello from MsgFlash!"
  }'
Response: 
{
  "data": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "instanceId": "YOUR_INSTANCE_ID",
    "type": "text",
    "to": "+33612345678",
    "body": "Hello from MsgFlash!",
    "status": "queued",
    "createdAt": "2026-04-01T10:00:00.000Z",
    "updatedAt": "2026-04-01T10:00:00.000Z"
  }
}

​
Step 5 — Check the status

curl https://srv.msgflash.com/api/v1/messages/a1b2c3d4-e5f6-7890-abcd-ef1234567890 \
  -H "x-api-key: msgf_live_your_api_key_here"
Example once delivered: 
{
  "data": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "status": "delivered",
    "providerMessageId": "BAE5D1A2B3C4D5E6"
  }
}

​
Next steps

Send with a template

Create a template and then use templateId and variables in your sends.

Schedule a message

Program a message for later.

Launch a campaign

Send either a template or a direct message to all your contacts or a targeted segment.

Manage contacts

Prepare your contact base before your campaigns.