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.
- Find your workspace ID.
- Call Create draft campaign with a name, for example
{ "name": "September interviews" }. Send a uniqueIdempotency-Keyfor this creation; reuse it only when retrying the same request. - Track the returned operation. On success, save
result.campaignIdand check thatresult.statusisdraft. - 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
updatedAtvalue in the requiredIf-Matchheader; if it changes before your update, read it again before retrying. - Attach a sequence or copy one from another campaign in the same workspace.
- 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. AI-generated mode has additional onboarding requirements; check the endpoint before choosing it. Copying a sequence replaces the target draft's existing sequence.
Launching is a separate action. Leave the campaign in draft until you have reviewed the recipients, content, sending accounts and schedule.