Skip to main content
POST
/
v1
/
automations
/
{automationId}
/
run
Run a manual-audience automation
curl --request POST \
  --url https://brew.new/api/v1/automations/{automationId}/run \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "scheduledAt": "2026-07-01T15:00:00.000Z"
}
'
{
  "dry_run": true,
  "automationId": "auto_abc",
  "audienceId": "aud_123",
  "audienceName": "Active trial users",
  "recipientCount": 12400,
  "sendNodeCount": 2
}

Authorizations

​
Authorization
string
header
default:Bearer brew_your_api_key
required

Send your Brew API key as Authorization: Bearer brew_xxx.

Headers

​
Idempotency-Key
string

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

Required string length: 1 - 100

Path Parameters

​
automationId
string
required

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

Required string length: 1 - 64
Example:

"auto_abc"

Body

application/json
​
dry_run
boolean
​
scheduledAt
string<date-time>

Response

Dry-run preview (no run started).

​
dry_run
enum<boolean>
required
Available options:
true
​
automationId
string
required
​
audienceId
string
required
​
recipientCount
number
required
​
sendNodeCount
number
required
​
audienceName
string
​
scheduledAt
string