Action types
Each campaign has anaction_type that determines what ReachOwl does:
Audience and platform
Campaigns target audiences defined by type and platform.audience_type— currentlygroupis supported, which targets members of a Facebook group.platform— currentlyfacebookis supported.
[] when omitted.
Status and control
You control a campaign’s lifecycle through thestatus field in the request body. There is no separate /pause or /resume endpoint.
You create a campaign with
POST /api/v1/campaigns/create by defaulting to status: 0 and then update it to status: 1 with POST /api/v1/campaigns/update. You can also clone a campaign by sending clone_from: {existing_campaign_id} in the create body.
Daily limit
Thelimit field sets the maximum number of actions the campaign performs per day. The default value is 30. You can set this during creation or update it later to speed up or slow down a campaign.
Schedule
Use theschedule array to restrict when actions are sent. Each entry must include a day name, a start time, and an end time.
Messages and placeholders
Message campaigns send one or moremessages entries. Each entry contains the message text and an optional delay (in minutes) before the next message is sent.
You can personalize messages with the {{first_name}} placeholder, which ReachOwl replaces with the contact’s first name when the message is sent.
Executors
Campaigns run through connected social accounts called executors. You link executors by providingexecutor_ids, which are the id values returned by GET /api/v1/app-states.
Minimal create example
Related endpoints
/api-reference/campaigns/create— create a campaign/api-reference/campaigns/update— update status, schedule, messages, and limits/api-reference/campaigns/list— list campaigns/api-reference/campaigns/get— retrieve a single campaign
