Skip to main content

​
Welcome to FlowMod API

FlowMod provides a comprehensive WhatsApp Web API that allows you to integrate WhatsApp messaging functionality directly into your applications. Send messages, manage groups, handle webhooks, and more - all through a simple REST API.

​
API Categories

Our API is organized into several categories:

Instance Management

Check connection status and manage your WhatsApp instance

Messaging

Send text, media, audio, location, polls, contacts, and reactions

Group Management

Create groups, manage participants, and update group settings

Plants

Sample plant store endpoints for demonstration

​
Authentication

All FlowMod API endpoints use API key authentication. Include your API key in the header of every request: 
apikey: YOUR_INSTANCE_API_KEY

​
Example Request

curl -X GET "https://api.flowmod.ai/instance/connectionState/your-instance" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/json"

​
Response Format

All FlowMod endpoints return responses in a consistent format: 
{
  "status": 200,
  "error": false,
  "response": {
    // Endpoint-specific data
  }
}

​
Getting Started

  1. Get your API credentials from your FlowMod dashboard
  2. Choose an endpoint from the categories below
  3. Make your first API call using the interactive playground

View OpenAPI Specification

Download the complete OpenAPI spec for FlowMod API