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

Run a manual-audience automation

cURL

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"
}
'

import requests

url = "https://brew.new/api/v1/automations/{automationId}/run"

payload = { "scheduledAt": "2026-07-01T15:00:00.000Z" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({scheduledAt: '2026-07-01T15:00:00.000Z'})
};

fetch('https://brew.new/api/v1/automations/{automationId}/run', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://brew.new/api/v1/automations/{automationId}/run",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'scheduledAt' => '2026-07-01T15:00:00.000Z'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://brew.new/api/v1/automations/{automationId}/run"

	payload := strings.NewReader("{\n  \"scheduledAt\": \"2026-07-01T15:00:00.000Z\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://brew.new/api/v1/automations/{automationId}/run")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"scheduledAt\": \"2026-07-01T15:00:00.000Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://brew.new/api/v1/automations/{automationId}/run")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"scheduledAt\": \"2026-07-01T15:00:00.000Z\"\n}"

response = http.request(request)
puts response.read_body

200

{
  "dry_run": true,
  "automationId": "auto_abc",
  "audienceId": "aud_123",
  "audienceName": "Active trial users",
  "recipientCount": 12400,
  "sendNodeCount": 2
}

{
  "audienceRunId": "arun_01HZ",
  "automationId": "auto_abc",
  "status": "queued",
  "totalRecipients": 12400,
  "receivedAt": "2026-04-08T12:34:56.789Z"
}

{
  "error": {
    "code": "INVALID_API_KEY",
    "type": "authentication_error",
    "message": "The provided API key is invalid.",
    "suggestion": "Check the API key format and retry with a valid active key.",
    "docs": "https://docs.brew.new/api-reference/api/authentication"
  }
}

{
  "error": {
    "code": "INSUFFICIENT_PERMISSIONS",
    "type": "authorization_error",
    "message": "The caller does not have the required permission.",
    "suggestion": "Use an API key or session with the required permission.",
    "docs": "https://docs.brew.new/api-reference/api/authentication",
    "param": "automations"
  }
}

{
  "error": {
    "code": "AUTOMATION_NOT_FOUND",
    "type": "not_found",
    "message": "Automation 'auto_xxx' was not found.",
    "suggestion": "List automations with GET /v1/automations.",
    "docs": "https://docs.brew.new/api-reference/api/errors",
    "param": "automationId"
  }
}

{
  "error": {
    "code": "IDEMPOTENCY_CONFLICT",
    "type": "conflict",
    "message": "The same idempotency key was reused with a different request payload.",
    "suggestion": "Reuse the original payload or send a new idempotency key.",
    "docs": "https://docs.brew.new/api-reference/api/idempotency"
  }
}

{
  "error": {
    "code": "RATE_LIMITED",
    "type": "rate_limit",
    "message": "Too many requests.",
    "suggestion": "Wait for the retry window before sending another request.",
    "docs": "https://docs.brew.new/api-reference/api/rate-limits",
    "retryAfter": 42
  }
}

{
  "error": {
    "code": "INTERNAL_ERROR",
    "type": "internal_error",
    "message": "An unexpected error occurred.",
    "suggestion": "Retry the request. If it keeps failing, contact support.",
    "docs": "https://docs.brew.new/api-reference/api/errors"
  }
}

Authorizations

bearerAuthapiKeyAuth

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>

gradualSend · object

Show child attributes

Response

200

application/json

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