Rocketlead
    • Welcome to RocketLead
    • Accounts
      • List WA accounts
        GET
      • Get account by ID
        GET
      • Get account activity
        GET
      • Register phone on WhatsApp
        POST
      • Connect WA account
        POST
      • Setup account profile
        POST
      • Toggle account pause state
        POST
      • Update account phase
        PATCH
      • Set account display name
        POST
      • Set account avatar
        POST
    • Campaigns
      • List campaigns
        GET
      • Create campaign
        POST
      • Get campaign by ID
        GET
      • Update campaign
        PATCH
      • Delete campaign
        DELETE
      • Add step to campaign
        POST
      • Update campaign step
        PATCH
      • Delete campaign step
        DELETE
      • Reorder campaign steps
        PUT
      • Upload campaign media
        POST
      • Send test message for a campaign step
        POST
      • Start campaign
        POST
      • Pause campaign
        POST
      • Add leads to campaign
        POST
      • List campaign leads
        GET
      • Bulk lead action
        POST
      • Import leads into campaign
        POST
      • Get campaign daily stats
        GET
      • Duplicate campaign
        POST
      • Archive campaign
        POST
    • Leads
      • List all leads
      • List all lead tags
      • Update a lead
      • Bulk delete leads
      • List custom field definitions
      • Create custom field definition
    • Lead Lists
      • List lead lists
      • Create lead list
      • Get lead list by ID
      • Delete lead list
      • List leads in a list
      • Add lead to list
      • Bulk import leads to list
    • Conversations
      • List conversations
      • Get conversation messages
      • Send message in conversation
      • Update conversation tags
      • Toggle conversation read status
      • Schedule a message
      • List scheduled messages
      • Cancel scheduled message
      • List conversation tags
      • Create conversation tag
      • Delete conversation tag
      • Bulk conversation action
      • Get contact by phone
      • Update contact
      • Send test message
    • Agents
      • List agents
      • Create agent
      • Get agent usage stats
      • Get agent by ID
      • Update agent
      • Delete agent
      • Test agent with a message
      • Get competitor analysis
      • Run competitor analysis
    • Warmup
      • Get warmup status
      • Pause warmup for account
      • Resume warmup for account
    • Credits
      • Get current credit balance
      • List credit transactions
    • Orders
      • Create a new order
      • List orders
      • Get order details
    • Provision
      • Start provisioning by requesting OTP
      • Verify OTP and complete provisioning
    • Settings
      • Get workspace settings
      • Update workspace settings
    • Knowledge Base
      • List knowledge base sources
      • Create knowledge base source
      • Discover links from URL
      • Delete knowledge base source
      • Re-ingest knowledge base source
      • Get source chunks
      • Get knowledge base stats

    Welcome to RocketLead

    Welcome to RocketLead#

    RocketLead API Documentation.

    Introduction#

    RocketLead is the most powerful platform for automating your WhatsApp outreach at scale. Manage campaigns, conversations, and accounts across hundreds of WhatsApp numbers — all through intelligent automation.
    With RocketLead, you can:
    Automate campaigns — Build multi-step WhatsApp sequences with A/B testing, delays, conditions, and smart reply detection
    Manage accounts at scale — Provision, warm up, and operate hundreds of WhatsApp accounts from a single workspace
    Organize leads — Import, tag, and segment leads into lists for targeted outreach
    Handle conversations — Unified inbox for all your WhatsApp conversations with scheduling, tagging, and bulk actions
    Deploy AI agents — Configure AI-powered agents with custom prompts, tone, and knowledge bases to auto-respond to leads
    Track everything — Real-time analytics on delivery, read rates, replies, and credit usage

    Getting Started#

    Authentication#

    All API requests require authentication via an API key passed in the x-api-key header.
    To get your API key:
    1.
    Log in to your RocketLead Dashboard
    2.
    Navigate to Settings → API Keys
    3.
    Click Create API Key and give it a name
    4.
    Copy the key and store it securely — it won't be shown again
    Example request:
    Tip: You can also authenticate using an OAuth Bearer token via the Authorization: Bearer <token> header.

    Base URL#

    All API requests should be made to:
    https://api.rocketlead.com/api/v1

    Response Format#

    All successful responses are wrapped in a standard envelope:
    {
      "ok": true,
      "data": {
        // response payload
      }
    }
    Error responses follow the same structure:
    {
      "ok": false,
      "error": {
        "message": "Description of what went wrong"
      }
    }

    Rate Limits & Fair Usage#

    Rate limits depend on your plan tier. When you exceed the limit, you'll receive a 429 Too Many Requests response. Implement exponential backoff and batch operations where possible.
    Rate limit headers are included in every response:
    x-ratelimit-limit: 10000
    x-ratelimit-remaining: 9987
    x-ratelimit-reset: 1678900000
    PlanNumbersPriceRequests/minRequests/day
    Starter1–25$99/number/mo10,000250,000
    Growth26–100$89/number/mo20,000500,000
    Scale101–999$79/number/mo30,0001,000,000
    Custom1,000+Custom50,0005,000,000

    Core Resources#

    ResourceDescription
    AccountsProvision, connect, and manage WhatsApp accounts
    CampaignsCreate and run multi-step outreach sequences
    LeadsManage contacts with tags, custom fields, and bulk operations
    Lead ListsOrganize leads into lists for campaign targeting
    ConversationsUnified inbox — send messages, schedule, and tag conversations
    AgentsConfigure AI agents with custom prompts and knowledge bases
    WarmupMonitor and control account warmup progress
    CreditsCheck balance and view transaction history
    OrdersBulk-provision new WhatsApp accounts
    Knowledge BaseManage AI agent knowledge sources
    SettingsConfigure workspace preferences and webhooks

    Quick Start#

    1. List your accounts#

    2. Create a lead list and import leads#

    3. Create and launch a campaign#

    4. Check your inbox#

    Need Help?#

    Support: support@rocketlead.com
    Dashboard: app.rocketlead.com
    Modified at 2026-03-10 11:15:05
    Next
    List WA accounts
    Built with