Skip to main content
PATCH
/
automations
/
{id}
curl --request PATCH \
  --url https://api.autosend.com/v1/automations/60d5ec49f1b2c72d9c8b9abc \
  --header 'Authorization: Bearer AS_your-project-api-key' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Welcome Series — v2",
  "tags": ["onboarding", "v2"],
  "trackingClick": true,
  "active": true
}'

{
  "success": true,
  "data": {
    "id": "60d5ec49f1b2c72d9c8b9abc",
    "projectId": "60d5ec49f1b2c72d9c8b1111",
    "name": "Welcome Series",
    "description": "Sends a 2-email welcome flow when a contact is created",
    "status": "active",
    "entryCriteria": { "type": "contact_created" },
    "exitCriteria": { "type": "workflow_complete" },
    "steps": [
      { "stepId": "step_aa11", "type": "wait", "delay": { "value": 0, "unit": "minutes" } },
      { "stepId": "step_bb22", "type": "email", "email": { "templateId": "60d5ec49f1b2c72d9c8b1234" } }
    ],
    "tags": ["onboarding"],
    "trackingOpen": true,
    "trackingClick": true,
    "analytics": {
      "totalEntered": 1250,
      "totalCompleted": 980,
      "totalExited": 40,
      "totalActive": 230
    },
    "activeAt": "2026-05-08T10:00:00.000Z",
    "createdAt": "2026-05-01T08:00:00.000Z",
    "updatedAt": "2026-05-08T10:00:00.000Z"
  }
}
Updates a workflow automation. Only draft and paused workflows can be edited — active workflows must be paused first. Pass active: true to re-activate as part of the update.
When steps is provided, the supplied array fully replaces the existing step list. Steps not included will be removed and any in-flight executions on those steps will exit.
curl --request PATCH \
  --url https://api.autosend.com/v1/automations/60d5ec49f1b2c72d9c8b9abc \
  --header 'Authorization: Bearer AS_your-project-api-key' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Welcome Series — v2",
  "tags": ["onboarding", "v2"],
  "trackingClick": true,
  "active": true
}'

{
  "success": true,
  "data": {
    "id": "60d5ec49f1b2c72d9c8b9abc",
    "projectId": "60d5ec49f1b2c72d9c8b1111",
    "name": "Welcome Series",
    "description": "Sends a 2-email welcome flow when a contact is created",
    "status": "active",
    "entryCriteria": { "type": "contact_created" },
    "exitCriteria": { "type": "workflow_complete" },
    "steps": [
      { "stepId": "step_aa11", "type": "wait", "delay": { "value": 0, "unit": "minutes" } },
      { "stepId": "step_bb22", "type": "email", "email": { "templateId": "60d5ec49f1b2c72d9c8b1234" } }
    ],
    "tags": ["onboarding"],
    "trackingOpen": true,
    "trackingClick": true,
    "analytics": {
      "totalEntered": 1250,
      "totalCompleted": 980,
      "totalExited": 40,
      "totalActive": 230
    },
    "activeAt": "2026-05-08T10:00:00.000Z",
    "createdAt": "2026-05-01T08:00:00.000Z",
    "updatedAt": "2026-05-08T10:00:00.000Z"
  }
}

​
Authorizations

​
Authorizations
string | header
required
Project API key header of the form Bearer AS_<key>.

​
Path Parameters

​
id
string
required
Workflow automation ID.

​
Body

All fields are optional. See Create Automation for the full shape of each field.
​
name
string
New workflow name. Maximum length 255.
​
description
string
Maximum length 1000.
​
entryCriteria
object
Replacement entry criteria.
​
exitCriteria
object
Replacement exit criteria.
​
steps
object[]
Replacement step list. Fully replaces the existing steps. Every email step must be preceded by a wait step (use a delay of 0 to send immediately), including email steps inside a branch.
​
tags
string[]
Replacement tag list.
​
unsubscribeGroupId
string
Suppression group applied to all email steps.
​
trackingOpen
boolean
​
trackingClick
boolean
​
active
boolean
When true, the workflow is validated and activated after the update. When false, the workflow is left in (or moved to) draft state.

​
Response

Workflow automation updated successfully
​
success
boolean
Example: true
​
data
object
The updated workflow automation.

​
Error Responses

​
400 - Cannot edit workflow
object
Returned when the workflow is active or archived — pause it first.
{
  "success": false,
  "error": {
    "message": "Only draft or paused workflows can be edited",
    "code": "CANNOT_EDIT_AUTOMATION"
  }
}
​
404 - Workflow not found
object
{
  "success": false,
  "error": {
    "message": "Workflow automation not found",
    "code": "WORKFLOW_NOT_FOUND"
  }
}