Back to Platform
Developer-First Infrastructure

RichAutomate
API V1 Reference.

"The most stable WhatsApp engine for high-scale enterprise integrations."

Getting Started

To begin integrating with the RichAutomate REST API, you must first obtain an **API Key** from your dashboard. Our API follows REST principles and returns JSON-encoded responses.

How to get your API Key:

  1. 1

    Login to Dashboard

    Navigate to your dashboard at richautomate.in/login

  2. 2

    Go to Settings

    Click on the **Settings** icon in the sidebar and select the **API Keys** tab.

  3. 3

    Generate Key

    Click "Generate New Key." Copy your key and store it securely. We will not show it again for security reasons.

Authentication

"RichAutomate uses Bearer Token authentication to secure every request. Ensure your key is kept private."

Required Header:
Authorization: Bearer ra_live_...

Send Template

HIGH PRIORITY

Trigger pre-approved Meta templates for order confirmations, OTPs, or notifications. Supports media headers (Image, Video, Document).

POST
/api/v1/send-template

Required Fields

  • phone: Target number (e.g. 919876543210)
  • template: Meta template name
  • language: Language code (e.g. "en")

Media Headers (Optional)

  • header_media_type: image | video | document
  • header_media_url: Publicly accessible URL
  • filename: Custom name for documents
Example JSON Payload:
{
  "phone": "919876543210",
  "template": "invoice_paid",
  "language": "en",
  "variables": ["INV-2024-001", "March 2024"],
  "header_media_type": "document",
  "header_media_url": "https://example.com/invoices/INV-001.pdf",
  "filename": "Invoice_INV001.pdf"
}

Trigger Campaign

NEW

Trigger a pre-defined marketing campaign for a specific contact. Useful for abandoned cart recovery or CRM triggers.

POST
/api/v1/send-campaign
{
  "phone": "919876543210",
  "campaign_id": "782"
}

Create with CSV

BULK API

Upload a CSV file to trigger a high-volume marketing or utility campaign. Our engine handles contact creation and variable mapping automatically.

POST
/api/v1/campaigns/create-with-csv

Required Form-Data

  • name: String (Internal name)
  • template_id: Integer (Template ID)
  • file: .csv (Max 10MB)

CSV Column Headers

  • phone: Target number (Required)
  • var_1, var_2: Template variables
Example cURL:
curl -X POST https://richautomate.in/api/v1/campaigns/create-with-csv \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "name=API_Campaign_001" \
  -F "template_id=12" \
  -F "file=@/path/to/your/contacts.csv"

Send Text Message

{
  "phone": "919876543210",
  "message": "Hello! Your agent is now online."
}

Ready to integrate?

Build your first WhatsApp integration in minutes with our robust SDKs.