POST /api/v1/campaigns, Create or Clone a Campaign

Create a new outreach campaign or clone an existing one. Supports Facebook, Instagram, and WhatsApp (group or CSV / file upload).

Create a new outreach campaign by providing its full configuration, or clone an existing campaign with clone_from. For WhatsApp, use platform: "whatsapp" with audience_type of group or file_upload, and action_type: "messages".

Create a new campaign

Body parameters

string

required

Name of the campaign.

string

required

Target platform: facebook, instagram, or whatsapp.

string

required

Outreach action. Use messages for WhatsApp. Facebook/Instagram also support friend_request, comments, and related actions.

string

required

Audience source. WhatsApp: group or file_upload. Facebook and Instagram support additional types (see Campaigns).

string

Source URL or id. Facebook/Instagram group or post URL; WhatsApp group id from Browsers sync (for example 1203630...@g.us). Not required for file_upload (upload contacts after create).

string

Optional internal group id when selected from the picker (Facebook/WhatsApp).

file

CSV for audience_type=file_upload. The UI uploads this as multipart after create. Via API you can also add rows with POST /api/v1/campaigns/{id}/contacts.

array

Extra CSV column names available as message merge variables.

integer

Team to own the campaign. Recommended; omit to use the token’s default team.

array

required

App-state IDs from GET /api/v1/app-states. Use a WhatsApp-connected executor for WhatsApp campaigns.

integer

Primary executor; typically executor_ids[0].

array

Message sequence. Required for action_type=messages. Each item has a text string array and optional delay.

array

Active time windows (day, start_time, end_time).

integer

default:"30"

Maximum actions per day.

integer

default:"1"

0 paused, 1 running.

array

default:"[]"

Keywords to include when filtering the audience.

array

default:"[]"

Keywords to exclude when filtering the audience.

array

default:"[]"

Target country codes.

array

default:"[]"

Comment keyword filter (Facebook/Instagram), or related WhatsApp contact filters in contacts mode.

Example â Facebook group

curl -X POST "https://reachowl.com/api/v1/campaigns" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Q3 Outreach",
    "platform": "facebook",
    "action_type": "friend_request",
    "audience_type": "group",
    "post_url": "https://facebook.com/groups/example",
    "team_id": 1,
    "executor_ids": [3, 7],
    "messages": [
      {
        "text": ["Hello!"],
        "delay": 5
      }
    ],
    "schedule": [
      {
        "day": "monday",
        "start_time": "09:00",
        "end_time": "17:00"
      }
    ],
    "limit": 30,
    "status": 1
  }'

Example â WhatsApp group messages

curl -X POST "https://reachowl.com/api/v1/campaigns" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "WA Group Outreach",
    "platform": "whatsapp",
    "action_type": "messages",
    "audience_type": "group",
    "post_url": "120363012345678901@g.us",
    "team_id": 1,
    "executor_ids": [55],
    "messages": [
      {
        "text": ["Hi {{first_name}}, thanks for being in the group!"],
        "delay": 0
      }
    ],
    "limit": 30,
    "status": 1,
    "schedule": [
      {
        "day": "Monday",
        "start_time": "09:00",
        "end_time": "17:00"
      }
    ]
  }'

Example â WhatsApp CSV / file upload

Create the campaign with file_upload, then add contacts:

curl -X POST "https://reachowl.com/api/v1/campaigns" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "WA CSV Outreach",
    "platform": "whatsapp",
    "action_type": "messages",
    "audience_type": "file_upload",
    "team_id": 1,
    "executor_ids": [55],
    "variables": ["area"],
    "messages": [
      {
        "text": ["Hi {{first_name}}, checking in about {{area}}."],
        "delay": 0
      }
    ],
    "limit": 30,
    "status": 0
  }'

curl -X POST "https://reachowl.com/api/v1/campaigns/102/contacts" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "audience": [
      {
        "name": "Ali Khan",
        "member_id": "923001234567@c.us",
        "profile_url": "https://wa.me/923001234567",
        "variables": { "area": "DHA Lahore" }
      }
    ]
  }'

Then start the campaign with PATCH /api/v1/campaigns/102 and {"status": 1}.

Clone an existing campaign

Body parameters

integer

required

ID of the existing campaign to duplicate.

Example request (clone)

curl -X POST "https://reachowl.com/api/v1/campaigns" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"clone_from": 101}'

Example response (201 Created)

{
  "id": 102,
  "name": "WA Group Outreach",
  "platform": "whatsapp",
  "action_type": "messages",
  "audience_type": "group",
  "post_url": "120363012345678901@g.us",
  "status": 1,
  "limit": 30,
  "executor_ids": [55],
  "messages": [
    {
      "text": ["Hi {{first_name}}, thanks for being in the group!"],
      "delay": 0
    }
  ],
  "created_at": "2024-01-15T12:00:00Z",
  "updated_at": "2024-01-15T12:00:00Z"
}

Getting Started

Concepts

Guides

Api Reference

POST /api/v1/campaigns, Create or Clone a Campaign

Create a new campaign

Body parameters

Example â Facebook group

Example â WhatsApp group messages

Example â WhatsApp CSV / file upload

Clone an existing campaign

Body parameters

Example request (clone)

Example response (201 Created)

​Create a new campaign

​Body parameters

​Example â Facebook group

​Example â WhatsApp group messages

​Example â WhatsApp CSV / file upload

​Clone an existing campaign

​Body parameters

​Example request (clone)

​Example response (201 Created)

Create a new campaign

Body parameters

Example â Facebook group

Example â WhatsApp group messages

Example â WhatsApp CSV / file upload

Clone an existing campaign

Body parameters

Example request (clone)

Example response (201 Created)