AcquisityDeveloper Docs
Practical guides

Create a draft campaign

Build a campaign without launching it.

Access: workspace API key with campaigns:write. Add read scopes to inspect the campaign and leads.

  1. Find your workspace ID.
  2. Call Create draft campaign with a name, for example { "name": "September interviews" }. Send a unique Idempotency-Key for this creation; reuse it only when retrying the same request.
  3. Track the returned operation. On success, save result.campaignId and check that result.status is draft.
  4. Update the draft to set its targeting, sending accounts and schedule using the reference's supported fields. First read the campaign and send its current updatedAt value in the required If-Match header; if it changes before your update, read it again before retrying.
  5. Attach a sequence or copy one from another campaign in the same workspace.
  6. Find and attach leads, then check readiness.

Success: the campaign exists as a draft. Creating it does not launch, schedule or send email. Any campaign-created notifications or automations configured for the workspace may run.

For sequence attachment, supplying steps stores your subjects and bodies as supplied. Every variant on the first step (index 0) needs a subject; later steps may send "" or omit it to reply in the first email's thread. AI-generated mode has additional onboarding requirements; check the endpoint before choosing it. Copying a sequence replaces the target draft's existing sequence.

Once a sequence exists, edit a variant to turn it on or off or change its subject and body, or add a step to the end. Both work on draft and live campaigns and need the campaign's updatedAt in an If-Match header. Each returns the new updatedAt when the operation finishes, so wait for one edit to finish before sending the next. On an active campaign a new step starts turned off; enable it with the variant endpoint. Steps cannot be removed through the API. A follow-up step (index 1 and up) can have an empty or missing subject, which sends it as a reply in the first email's thread; the first step (index 0) always needs a subject.

Launching is a separate action. Leave the campaign in draft until you have reviewed the recipients, content, sending accounts and schedule.