Sales Engine
API documentation
CampaignsOperation campaigns.create

Create a campaign

Create a draft campaign, optionally from lead lists or as a duplicate.

POST/api/v1/campaigns
Scope write: Create and edit lists, research, sequences, campaigns, memory, signals and learning; queue jobs.

Parameters

Body

A JSON object. Fields not listed are ignored.

NameInDescription
namebodyCampaign name.
lead_list_idsbody, arrayLists to import.
duplicate_ofbodyCampaign to copy.

Example

curl
curl -X POST "https://crm.ashwanth.dev/api/v1/campaigns" \
  -H "Authorization: Bearer $SALES_ENGINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "",
  "lead_list_ids": [],
  "duplicate_of": ""
}'
CLI
sales-engine campaigns create

The JSON above lists every documented field with a typed placeholder; send only the ones you mean.

Response

A 200 with the result under data, on creation too. Errors come back as an error object with a stable code; see Errors.

Shape
{
  "data": { ... }
}

Run it below to see the live shape for your workspace.

Try it

Runs against this server, as the workspace behind the key.
Kept in this page while you browse the docs, gone on reload, never stored. Signed in to the app? Leave it blank and the call runs as you.
Every documented field is listed above; leave out the ones you do not need.
Request
POST /api/v1/campaigns

Also in Campaigns