Get Started with ReachOwl API

Make your first ReachOwl API call in minutes. Authenticate, retrieve your team ID, and launch a Facebook, Instagram, or WhatsApp outreach campaign.

The ReachOwl API is a direct HTTP API. There is no package to install. All you need is any HTTP client (curl, Postman, Insomnia, or your language built-in HTTP library) and your ReachOwl credentials.

Prerequisites

A ReachOwl account (any plan)
Your account email and password
At least one connected browser with a linked Facebook, Instagram, or WhatsApp account (visible in your dashboard under Browsers)

For WhatsApp group or CSV messaging, see Create WhatsApp Campaigns.

Authenticate

Exchange your email and password for a Bearer token. No special headers are needed for this request.

curl -X POST "https://reachowl.com/api/v1/authenticate" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "email": "you@example.com",
    "password": "your_password"
  }'

{
  "token": "2521|R4ek1kqRMr1XeemICKF3p8tIZ14Hw5qjTvixdUpm..."
}

Save the token value. You will pass it as Authorization: Bearer YOUR_TOKEN on every subsequent request.

Get your team ID

Fetch your user profile to find your team_id. You need this when creating campaigns and querying contacts.

curl "https://reachowl.com/api/v1/user" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Accept: application/json"

{
  "id": 42,
  "email": "you@example.com",
  "team_id": 10
}

Note the team_id value.

Find your executor IDs

List your connected social accounts (app-states). Each entry has an id that you pass as executor_ids when creating a campaign. For WhatsApp, pick an entry where platform is whatsapp.

curl "https://reachowl.com/api/v1/app-states" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Accept: application/json"

[
  {
    "id": 55,
    "platform": "facebook",
    "status": "active"
  }
]

Save one or more id values as your executor IDs.

Create a campaign

Create a Facebook group outreach campaign. Replace post_url with a synced group URL from GET /api/v1/groups. For WhatsApp group or CSV upload flows, use the WhatsApp campaign guide.

curl -X POST "https://reachowl.com/api/v1/campaigns" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "name": "My First Campaign",
    "team_id": 10,
    "platform": "facebook",
    "action_type": "friend_request",
    "audience_type": "group",
    "post_url": "https://www.facebook.com/groups/123456789",
    "executor_ids": [55],
    "messages": [
      {
        "text": ["Hi there, great to connect!"],
        "delay": 0
      }
    ],
    "schedule": [
      {
        "day": "Monday",
        "start_time": "09:00:00",
        "end_time": "17:00:00"
      }
    ]
  }'

A 201 response includes the new campaign object with its id. The campaign starts running immediately when status is 1. To pause it, send PATCH /api/v1/campaigns/{id} with status set to 0.

Next steps

Authentication â how tokens work
Campaigns â platforms including WhatsApp, scheduling, limits
WhatsApp Campaigns â group and CSV messaging
API Reference â full endpoint list

Getting Started

Concepts

Guides

Api Reference

Get Started with ReachOwl API

Prerequisites

Authenticate

Get your team ID

Find your executor IDs

Create a campaign

Next steps

​Prerequisites

​Authenticate

​Get your team ID

​Find your executor IDs

​Create a campaign

​Next steps

Prerequisites

Authenticate

Get your team ID

Find your executor IDs

Create a campaign

Next steps