Launch a campaign
Launch: enrolls approved leads, locks the shape, the runner sends inside the mailbox windows.
POST/api/v1/campaigns/{id}/launch
This call sends email or changes what sends. A key needs the send scope, and the Try it panel asks you to confirm before it runs.
Parameters
Path
| Name | In | Description |
|---|---|---|
idrequired | path | The record's id. |
Body
A JSON object. Fields not listed are ignored.
| Name | In | Description |
|---|---|---|
mode | body | now or scheduled. One of now, scheduled. |
scheduled_at | body | ISO time when scheduled. |
scheduled_local | body | Wall-clock start, YYYY-MM-DDTHH:mm, read in timezone. |
timezone | body | IANA time zone for scheduled_local, kept on the campaign. |
Example
curl
curl -X POST "https://crm.ashwanth.dev/api/v1/campaigns/{id}/launch" \
-H "Authorization: Bearer $SALES_ENGINE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"mode": "now",
"scheduled_at": "",
"scheduled_local": "",
"timezone": ""
}'CLI
sales-engine campaigns launch <id>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.
Path
requiredThe record's id.
Every documented field is listed above; leave out the ones you do not need.
Request
POST /api/v1/campaigns/%7Bid%7D/launch
Fill the path first.