Update or publish an automation

One endpoint, two mutually-exclusive modes:

• Update — supply one or more of name, description, nodes, connections, triggerEventId. Graph updates persist a new automationVersionId on the same automationId. Add dryRun: true to validate a graph update without persisting.
• Lifecycle — supply published: true to promote the stored latest version live (validates the graph first → 409 PUBLISH_VALIDATION_FAILED on blockers; optionally pin automationVersionId to publish a specific version), or published: false to unpublish.

Graph updates use the same strict typed filter/split condition contract as create: explicit type, canonical snake_case operator, no value for unary operators, and type-correct values everywhere else.

The two modes cannot be combined: publishing promotes the stored graph, so update first, then PATCH { "published": true }. Returns the bare automation row.

PATCH /v1/automations/{automationId}

cURL

rename

curl --request PATCH \
  --url https://brew.new/api/v1/automations/{automationId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Welcome flow v2"
}
'

200

{
  "automationId": "auto_abc",
  "automationVersionId": "av_v1",
  "triggerEventId": "tri_signup",
  "name": "Welcome flow",
  "version": "latest",
  "published": false,
  "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"
    }
  ],
  "emailIds": [
    "eml_welcome"
  ],
  "createdAt": "2026-04-08T12:00:00.000Z",
  "updatedAt": "2026-04-08T12:00:00.000Z"
}

{
  "error": {
    "code": "INVALID_REQUEST",
    "type": "invalid_request",
    "message": "Provide `published` to publish/unpublish, or at least one of `name`, `description`, `nodes`, `connections`, or `triggerEventId` to update.",
    "suggestion": "Send a lifecycle (`published`) or at least one editable field.",
    "docs": "https://docs.brew.new/api-reference/api/errors",
    "param": "published"
  }
}

{
  "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": "PUBLISH_VALIDATION_FAILED",
    "type": "conflict",
    "message": "Add at least one Send Email action",
    "suggestion": "Fix every blocker reported in `details.blockers` then publish again.",
    "docs": "https://docs.brew.new/api-reference/api/errors",
    "param": "published"
  }
}

{
  "error": {
    "code": "AUTOMATION_NOT_PUBLISHED",
    "type": "invalid_request",
    "message": "Automation 'auto_abc' is not currently published — nothing to unpublish.",
    "suggestion": "Verify the automation is published via GET /v1/automations?automationId=.",
    "docs": "https://docs.brew.new/api-reference/api/errors",
    "param": "published"
  }
}

{
  "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

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

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

name · string

Required string length: 1 - 120

description · string

Maximum string length: 2000

nodes · object[]

Maximum array length: 500

Option 1

Option 2

Option 3

Option 4

Option 5

Show child attributes

connections · object[]

Maximum array length: 1000

Show child attributes

triggerEventId · string

Required string length: 1 - 256

dryRun · boolean

published · boolean

automationVersionId · string

Required string length: 1 - 64

stop_in_flight · boolean

paused · boolean

Response

200

application/json

Updated / published / unpublished. The bare automation row (or the dry-run result when dryRun: true).

automationId · string · required

Required string length: 1 - 64

automationVersionId · string · required

Required string length: 1 - 64

name · string · required

Required string length: 1 - 120

version · integer enum<string> · required

Required range: x >= 0

published · boolean · required

emailIds · string[] · required

Required string length: 1 - 64

triggerEventId · string

Required string length: 1 - 256

description · string

Maximum string length: 2000

paused · boolean

pausedAt · number

nodes · object[]

Option 1

Option 2

Option 3

Option 4

Option 5

Show child attributes

connections · object[]

Show child attributes

createdBy · string

createdAt · string<date-time>

updatedAt · string<date-time>

publishedAt · string<date-time>

versions · object[]

Show child attributes