Create an automation

Deterministic create — the body carries the full graph ({ name, triggerEventId?, nodes, connections }). Returns 201 with the bare AutomationRow.

Trigger binding (exactly one): for an EVENT automation pass triggerEventId (then publish with PATCH … { "published": true }). For a MANUAL-AUDIENCE automation OMIT triggerEventId and give the trigger node config: { "mode": "manualAudience", "audienceId": "aud_…" } — it is launched on demand with POST /v1/automations/{automationId}/run rather than published.

Typed conditions: every filter and condition-mode split uses a non-empty conditions array. Each condition requires field, type (string, number, date, or bool), and a canonical snake_case operator. Unary operators omit value; comparisons require a type-correct scalar, non-empty array, or exact two-value between tuple as documented by AutomationNode.

Chain POST /v1/emails { prompt } first to mint the design each sendEmail node references — every sendEmail node MUST carry emailId, emailVersionId, subject (previewText is optional: the email design’s JSX <Preview> is the preview source of truth). domainId is optional on create/save; publishing (PATCH … { published: true }) or running (POST …/run) requires a verified domainId from GET /v1/domains. messageClass is optional and behaves as "marketing" at send time when unset.

Dry-run — add dryRun: true (alias dry_run) to validate without persisting; returns 200 with an AutomationDryRunReport: { valid, blockers[], warnings[], blockingIssues[], nodeCounts }. blockers[] (severity error) fail publish; warnings[] are advisory. blockingIssues[] lists per-node references the bound trigger or contact catalog cannot provide. valid is false when any blocker or any blocking issue is present.

POST /v1/automations

cURL

deterministic

curl --request POST \
  --url https://brew.new/api/v1/automations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Welcome flow",
  "description": "Welcome new signups",
  "triggerEventId": "tri_signup",
  "nodes": [
    {
      "id": "trg",
      "label": "On signup",
      "type": "trigger",
      "config": {
        "actionType": "trigger"
      }
    },
    {
      "id": "send_welcome",
      "label": "Welcome",
      "type": "sendEmail",
      "config": {
        "actionType": "sendEmail",
        "emailId": "eml_welcome",
        "emailVersionId": "emv_welcome_v1",
        "domainId": "kx7bkh53hasmfeh5kd7sqgykt187g8ww",
        "subject": "Welcome to Brew, {{firstName | there}}!",
        "previewText": "Thanks for signing up — get started in 2 minutes.",
        "fromName": "Brew",
        "replyTo": "[e-mail]"
      }
    }
  ],
  "connections": [
    {
      "from": "trg",
      "to": "send_welcome"
    }
  ]
}
'

200

Example

{
  "valid": false,
  "blockers": [
    {
      "severity": "error",
      "message": "Add at least one Send Email action"
    }
  ],
  "warnings": [],
  "blockingIssues": [],
  "nodeCounts": {
    "sendEmail": 0,
    "wait": 0,
    "filter": 0,
    "split": 0
  }
}

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

X-Brand-Id · string

The brand this request acts on. REQUIRED for organization-scoped credentials (otherwise 400 BRAND_ID_REQUIRED — there is no default brand); list ids with GET /v1/brands. Brand-scoped credentials may omit it, and sending a different brand returns 403 BRAND_SCOPE_MISMATCH. A brand outside your organization returns 404 BRAND_NOT_FOUND.

Required string length: 1 - 64

Body

application/json

name · string · required

Required string length: 1 - 120

nodes · object[] · required

Maximum array length: 500

Option 1

Option 2

Option 3

Option 4

Option 5

Show child attributes

description · string

Maximum string length: 2000

triggerEventId · string

Required string length: 1 - 256

connections · object[]

Maximum array length: 1000

Show child attributes

dryRun · boolean

Validate only — runs the full publish-gate check and returns blockers/warnings without creating anything.

dry_run · boolean

Accepted alias of dryRun.

Response

200

application/json

Dry-run result (returned only for dryRun: true; no writes). valid is false when any blockers[] entry or any blockingIssues[] entry is present. Create and update both return blockingIssues[] (possibly empty).

valid · boolean · required

Whether the graph would publish cleanly. false when any blockers[] entry or any blockingIssues[] entry is present.

blockers · object[] · required

Publish blockers (severity: "error"). Publishing fails while any remain.

Show child attributes

warnings · object[] · required

Advisory findings (severity: "warning"). Publishing succeeds despite them.

Show child attributes

nodeCounts · object · required

Per-kind node counts of the validated graph.

Show child attributes

blockingIssues · object[]

Trigger-payload / draft-variable compatibility findings. Present (possibly empty) on POST and PATCH dry-run responses. valid is false when any entry is present.

Show child attributes