v1

latestOpenAPI 3.1.02026-07-2670105729.6 KB
Automations

Run a manual-audience automation

Launches a MANUAL-AUDIENCE automation against the audience bound to its trigger node. dry_run: true previews without sending; scheduledAt launches later. Percentage-based gradualSend delivers each send step in custom hour or calendar-day batches and supports manual pause/resume/cancel. 400 when the resolved plan exceeds 50,000 recipients, 30 batches, or 30 elapsed days. Returns 202 with the audienceRunId.

post/v1/automations/{automationId}/run

Path parameters

automationIdstring required

Automation id returned by POST /v1/automations and listed by GET /v1/automations.

Example:auto_abc

Automation id returned by POST /v1/automations and listed by GET /v1/automations.

Headers

Idempotency-Keystring

Optional idempotency key for safe retries. Reusing the same key with the same request body returns the original response for 24 hours.

Request body

dry_runboolean
scheduledAtstring date-time

Response

Dry-run preview (no run started).

dry_runtrue required
automationIdstring required
audienceIdstring required
audienceNamestring
recipientCountnumber required
sendNodeCountnumber required
scheduledAtstring