Skip to main content
PATCH
/
v1
/
automations
/
{automationId}
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"
}
'
{
  "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": "support@example.com"
      }
    }
  ],
  "connections": [
    {
      "from": "trg",
      "to": "send_welcome"
    }
  ],
  "emailIds": [
    "eml_welcome"
  ],
  "createdAt": "2026-04-08T12:00:00.000Z",
  "updatedAt": "2026-04-08T12:00:00.000Z"
}

Authorizations

​
Authorization
string
header
default:Bearer brew_your_api_key
required

Send your Brew API key as Authorization: Bearer brew_xxx.

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
​
connections
object[]
Maximum array length: 1000
​
triggerEventId
string
Required string length: 1 - 256
​
dryRun
boolean
​
published
boolean
​
automationVersionId
string
Required string length: 1 - 64

Response

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
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
​
nodes
object[]
​
connections
object[]
​
createdBy
string
​
createdAt
string<date-time>
​
updatedAt
string<date-time>
​
publishedAt
string<date-time>
​
versions
object[]