Skip to main content
POST
/
send-whatsapp
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": "text",
  "text": "Hello! This is a test message from FlowIQ API."
}
'
{
  "success": true,
  "message": "Message sent successfully",
  "data": {
    "message_id": "wamid.HBgLMjc4MTIzNDU2NzgVAgASGBQzRUI...",
    "recipient": "27123456789",
    "message_type": "text"
  }
}

​
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": "contacts",
    "contacts": [
      {
        "name": { "formatted_name": "John Doe", "first_name": "John", "last_name": "Doe" },
        "phones": [{ "phone": "+27987654321", "type": "CELL" }]
      }
    ]
  }'

​
Request Body

FieldTypeRequiredDescription
phone_numberstringYesRecipient phone number with country code
message_typestringYesMust be "contacts"
contactsarrayYesArray of contact objects to share
contacts[].name.formatted_namestringYesFull display name
contacts[].name.first_namestringNoFirst name
contacts[].name.last_namestringNoLast name
contacts[].phones[].phonestringYesPhone number
contacts[].phones[].typestringNoPhone type (e.g. "CELL", "WORK")
context_message_idstringNoWhatsApp message ID to reply to
{
  "phone_number": "+27123456789",
  "message_type": "contacts",
  "contacts": [
    {
      "name": { "formatted_name": "John Doe", "first_name": "John", "last_name": "Doe" },
      "phones": [{ "phone": "+27987654321", "type": "CELL" }]
    }
  ]
}

​
Response

​
Success (200)

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

​
Error: Missing Required Field (400)

{
  "error": "Missing required field",
  "message": "contacts array is required for contact messages"
}

​
Integration Example

async function sendContactCard(apiKey, phoneNumber, contacts) {
  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: "contacts", contacts }),
    }
  );
  const data = await response.json();
  if (!response.ok) throw new Error(data.message);
  return data;
}

Authorizations

​
Authorization
string
header
required

Bearer token for authentication. Format: Bearer YOUR_BEARER_TOKEN

Query Parameters

​
tenantId
string
required

Organization tenant identifier (slug)

Body

application/json
​
phone_number
string
required

Recipient phone number with country code

Example:

"+27123456789"

​
message_type
enum<string>
required

Type of message to send

Available options:
text,
image,
video,
audio,
document,
location,
contacts,
interactive,
reaction
Example:

"text"

​
text
string

Text content (required for text messages)

Example:

"Hello, World!"

​
media_url
string

URL to media file (required for image/video/audio/document)

Example:

"https://example.com/image.jpg"

​
caption
string

Caption for media messages

Example:

"Check this out!"

​
filename
string

Filename for document messages

Example:

"document.pdf"

​
location
object
​
contacts
object[]

Array of contact cards to share

​
interactive
object

Interactive message configuration

​
reaction
object

Reaction configuration

​
context_message_id
string

WhatsApp message ID to reply to

Example:

"wamid.HBgLMjc4MTIzNDU2NzgVAgASGBQzRUI..."

Response

Message sent successfully

​
success
boolean
required

Whether the message was sent successfully

Example:

true

​
message
string
required

Success message

Example:

"Message sent successfully"

​
data
object
required