Create an outreach campaign

Creates a campaign against a project the caller owns: who it reaches, what the invite note and first message say, and whether every batch waits for the owner (copilot) or the campaign runs inside the limits they set (autopilot). Creating a campaign sends nothing. People it later collects wait in a review queue. Rate-limited to 20/hour per account, shared with the dashboard. Requires an outreach-scope API key (Pro plan or higher).

post/api/v1/campaigns

Request

  • Base URL: https://www.easeclaw.com
  • URL: https://www.easeclaw.com/api/v1/campaigns
  • Auth: HTTP bearer

Request body

project_idstring uuid required

The project this campaign belongs to

namestring required
source_type'competitor_harvest' | 'signal' | 'profile_urls' | 'csv' | 'basic_search' | 'sales_navigator' | 'recruiter' | 'my_network'

Where a campaign's people come from. Defaults to competitor_harvest.

source_urlstring

competitor_harvest: the LinkedIn company page, profile or post to mine. sales_navigator/recruiter: the saved search URL, stored byte for byte.

source_paramsobject

basic_search only: the search filters to re-run. Required for that kind.

signal_min_scoreinteger

signal campaigns: the intent bar a person with an intent signal must clear to be fed in; engagers are admitted on ICP fit instead

icpobject

This campaign's own targeting. Omit to inherit the project's ICP unchanged.

mode'autopilot' | 'copilot'

Who approves what goes out: autopilot: the agent approves inside the owner's limits; copilot: every batch waits for the owner. Neither mode is reachable from this API: it decides who approves, and this surface is not either of them.

invite_note_mode'none' | 'custom'
invite_note_templatestring
first_message_templatestring

The post-acceptance first message. {{first_name}} and {{meeting_link}} substitute at approval.

meeting_linkstring uri

https booking link that {{meeting_link}} substitutes

accept_wait_daysinteger
daily_quotainteger

Cap on how many of this campaign's people move per day

Response

The created campaign

sourceobject nullable

How the campaign's source was parsed, when it has one

Changes

No recorded changes to this operation across all 1 revision of this API.