Create a new campaign
Body parameters
string
required
Name of the campaign.
string
required
Social platform to target, for example facebook.
string
required
Outreach action, for example friend_request.
string
required
Audience source, for example group.
string
required
URL of the synced group or post to target.
integer
Team to own the campaign. Recommended; omit to use the token’s default team.
array
Array of executor IDs to run the campaign. Recommended.
array
Message sequence. Each item contains a text array and a delay value.
array
Active time windows. Each item contains day, start_time, and end_time.
integer
default:"30"
Maximum number of actions the campaign should perform.
integer
default:"1"
Initial status: 0 for paused, 1 for 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:"[]"
Keywords for comment-based filtering.
Example request (create)
Clone an existing campaign
Body parameters
integer
required
ID of the existing campaign to duplicate.