> ## Documentation Index
> Fetch the complete documentation index at: https://docs.autosend.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Create Automation
> Creates a new workflow automation. Pass `active: true` to activate the workflow as part of the create call.
## Quick note before you begin
* Creates a new workflow automation. By default the workflow is created in `draft` status. Pass `active: true` to validate and activate it as part of the create call.
* A workflow runs `steps` in order. Without `branch` steps, `steps` must strictly alternate `wait → email`, starting with `wait` and ending with `email`. Workflows containing `branch` steps use a more flexible graph (each step references the next via `nextStepId`).
* Every `email` step must be preceded by a `wait` step, including email steps inside a branch. Set the wait delay to `{ "value": 0, "unit": "mins" }` if you want the email to send immediately.
```bash cURL theme={null}
curl --request POST \
--url https://api.autosend.com/v1/automations \
--header 'Authorization: Bearer AS_your-project-api-key' \
--header 'Content-Type: application/json' \
--data '{
"name": "Branch with guard - pro vs other",
"description": "Pro plan gets a 2-email sequence with a guard that routes to a merged email if plan changes mid-flight. Other plans get a single welcome email.",
"active": true,
"entryCriteria": {
"type": "contact_property_matches_with",
"filterCriteria": {
"logicalOperator": "AND",
"groups": [
{ "field": "customFields.plan", "operator": "is_not_empty", "id": "filter_1", "fieldType": "string" }
]
}
},
"unsubscribeGroupId": "60d5ec49f1b2c72d9c8b4444",
"trackingOpen": true,
"trackingClick": true,
"exitCriteria": { "type": "workflow_complete" },
"tags": ["onboarding", "branch-guard"],
"steps": [
{
"type": "wait",
"delay": { "value": 2, "unit": "mins" },
"checkExitCriteria": true,
"stepId": "step_wait_intro",
"nextStepId": "step_email_intro"
},
{
"type": "email",
"email": {
"senderEmail": "team@example.com",
"senderName": "Example Team",
"projectId": "60d5ec49f1b2c72d9c8b1111",
"templateName": "Welcome - intro email",
"subject": "Welcome to Example!",
"previewText": "Glad to have you with us.",
"htmlTemplate": "Welcome {{firstName}}!
Thanks for joining.
"
},
"checkExitCriteria": true,
"stepId": "step_email_intro",
"nextStepId": "step_branch"
},
{
"stepId": "step_branch",
"type": "branch",
"branches": [
{
"branchId": "br_pro",
"label": "Pro plan",
"triggerType": "contact_property_matches_with",
"appliesTo": "all_branch_steps",
"filterCriteria": {
"logicalOperator": "AND",
"groups": [
{ "field": "customFields.plan", "operator": "equals", "value": "pro", "id": "filter_2", "fieldType": "string" }
]
},
"nextStepId": "step_wait_pro",
"mergeStepId": "step_wait_merged"
},
{
"branchId": "br_other",
"label": "Catch-all",
"triggerType": "contact_property_matches_with",
"appliesTo": "branch_entry",
"filterCriteria": {
"logicalOperator": "AND",
"groups": [
{ "field": "customFields.plan", "operator": "is_not_empty", "id": "filter_3", "fieldType": "string" }
]
},
"nextStepId": "step_wait_other"
}
]
},
{
"type": "wait",
"delay": { "value": 2, "unit": "mins" },
"checkExitCriteria": true,
"stepId": "step_wait_pro",
"parentBranchStepId": "step_branch",
"parentBranchId": "br_pro",
"nextStepId": "step_email_pro"
},
{
"stepId": "step_email_pro",
"type": "email",
"email": {
"senderEmail": "team@example.com",
"senderName": "Example Team",
"projectId": "60d5ec49f1b2c72d9c8b1111",
"templateName": "Welcome - pro email",
"subject": "Welcome to Pro, {{firstName}}",
"previewText": "Your Pro perks are ready.",
"htmlTemplate": "Welcome to Pro, {{firstName}}!
Your perks are ready.
"
},
"parentBranchStepId": "step_branch",
"parentBranchId": "br_pro",
"nextStepId": "step_wait_pro_followup"
},
{
"stepId": "step_wait_pro_followup",
"type": "wait",
"delay": { "value": 1, "unit": "minutes" },
"parentBranchStepId": "step_branch",
"parentBranchId": "br_pro",
"nextStepId": "step_email_pro_followup"
},
{
"stepId": "step_email_pro_followup",
"type": "email",
"email": {
"senderEmail": "team@example.com",
"senderName": "Example Team",
"projectId": "60d5ec49f1b2c72d9c8b1111",
"templateName": "Welcome - pro follow-up",
"subject": "A quick follow-up on your Pro plan",
"previewText": "Tips to get the most out of Pro.",
"htmlTemplate": "Hi {{firstName}}
Here are a few Pro tips.
"
},
"parentBranchStepId": "step_branch",
"parentBranchId": "br_pro"
},
{
"stepId": "step_wait_other",
"type": "wait",
"delay": { "value": 2, "unit": "mins" },
"checkExitCriteria": true,
"parentBranchStepId": "step_branch",
"parentBranchId": "br_other",
"nextStepId": "step_email_other"
},
{
"stepId": "step_email_other",
"type": "email",
"email": {
"senderEmail": "team@example.com",
"senderName": "Example Team",
"projectId": "60d5ec49f1b2c72d9c8b1111",
"templateName": "Welcome - standard email",
"subject": "Welcome to Example!",
"previewText": "Glad to have you with us.",
"htmlTemplate": "Welcome {{firstName}}!
Thanks for joining.
"
},
"parentBranchStepId": "step_branch",
"parentBranchId": "br_other"
},
{
"stepId": "step_wait_merged",
"type": "wait",
"delay": { "value": 2, "unit": "mins" },
"checkExitCriteria": true,
"nextStepId": "step_email_merged"
},
{
"stepId": "step_email_merged",
"type": "email",
"email": {
"senderEmail": "team@example.com",
"senderName": "Example Team",
"projectId": "60d5ec49f1b2c72d9c8b1111",
"templateName": "Welcome - merged email",
"subject": "Thanks for sticking with us, {{firstName}}",
"previewText": "A wrap-up note from the team.",
"htmlTemplate": "Thanks {{firstName}}!
Here is your wrap-up.
"
}
}
]
}'
```
```python Python theme={null}
import requests
url = "https://api.autosend.com/v1/automations"
headers = {
"Authorization": "Bearer AS_your-project-api-key",
"Content-Type": "application/json"
}
email_defaults = {
"senderEmail": "team@example.com",
"senderName": "Example Team",
"projectId": "60d5ec49f1b2c72d9c8b1111"
}
payload = {
"name": "Branch with guard - pro vs other",
"description": "Pro plan gets a 2-email sequence with a guard. Other plans get a single welcome email.",
"active": True,
"entryCriteria": {
"type": "contact_property_matches_with",
"filterCriteria": {
"logicalOperator": "AND",
"groups": [
{"field": "customFields.plan", "operator": "is_not_empty", "id": "filter_1", "fieldType": "string"}
]
}
},
"unsubscribeGroupId": "60d5ec49f1b2c72d9c8b4444",
"trackingOpen": True,
"trackingClick": True,
"exitCriteria": {"type": "workflow_complete"},
"tags": ["onboarding", "branch-guard"],
"steps": [
{"type": "wait", "delay": {"value": 2, "unit": "mins"}, "checkExitCriteria": True,
"stepId": "step_wait_intro", "nextStepId": "step_email_intro"},
{"type": "email",
"email": {**email_defaults, "templateName": "Welcome - intro email",
"subject": "Welcome to Example!", "previewText": "Glad to have you with us.",
"htmlTemplate": "Welcome {{firstName}}!
"},
"checkExitCriteria": True, "stepId": "step_email_intro", "nextStepId": "step_branch"},
{"stepId": "step_branch", "type": "branch", "branches": [
{"branchId": "br_pro", "label": "Pro plan",
"triggerType": "contact_property_matches_with", "appliesTo": "all_branch_steps",
"filterCriteria": {"logicalOperator": "AND", "groups": [
{"field": "customFields.plan", "operator": "equals", "value": "pro", "id": "filter_2", "fieldType": "string"}]},
"nextStepId": "step_wait_pro", "mergeStepId": "step_wait_merged"},
{"branchId": "br_other", "label": "Catch-all",
"triggerType": "contact_property_matches_with", "appliesTo": "branch_entry",
"filterCriteria": {"logicalOperator": "AND", "groups": [
{"field": "customFields.plan", "operator": "is_not_empty", "id": "filter_3", "fieldType": "string"}]},
"nextStepId": "step_wait_other"}
]},
{"type": "wait", "delay": {"value": 2, "unit": "mins"}, "checkExitCriteria": True,
"stepId": "step_wait_pro", "parentBranchStepId": "step_branch", "parentBranchId": "br_pro",
"nextStepId": "step_email_pro"},
{"stepId": "step_email_pro", "type": "email",
"email": {**email_defaults, "templateName": "Welcome - pro email",
"subject": "Welcome to Pro, {{firstName}}", "previewText": "Your Pro perks are ready.",
"htmlTemplate": "Welcome to Pro!
"},
"parentBranchStepId": "step_branch", "parentBranchId": "br_pro",
"nextStepId": "step_wait_pro_followup"},
{"stepId": "step_wait_pro_followup", "type": "wait",
"delay": {"value": 1, "unit": "minutes"},
"parentBranchStepId": "step_branch", "parentBranchId": "br_pro",
"nextStepId": "step_email_pro_followup"},
{"stepId": "step_email_pro_followup", "type": "email",
"email": {**email_defaults, "templateName": "Welcome - pro follow-up",
"subject": "A quick follow-up on your Pro plan", "previewText": "Tips to get the most out of Pro.",
"htmlTemplate": "Hi {{firstName}}
"},
"parentBranchStepId": "step_branch", "parentBranchId": "br_pro"},
{"stepId": "step_wait_other", "type": "wait", "delay": {"value": 2, "unit": "mins"},
"checkExitCriteria": True, "parentBranchStepId": "step_branch",
"parentBranchId": "br_other", "nextStepId": "step_email_other"},
{"stepId": "step_email_other", "type": "email",
"email": {**email_defaults, "templateName": "Welcome - standard email",
"subject": "Welcome to Example!", "previewText": "Glad to have you with us.",
"htmlTemplate": "Welcome {{firstName}}!
"},
"parentBranchStepId": "step_branch", "parentBranchId": "br_other"},
{"stepId": "step_wait_merged", "type": "wait", "delay": {"value": 2, "unit": "mins"},
"checkExitCriteria": True, "nextStepId": "step_email_merged"},
{"stepId": "step_email_merged", "type": "email",
"email": {**email_defaults, "templateName": "Welcome - merged email",
"subject": "Thanks for sticking with us, {{firstName}}",
"previewText": "A wrap-up note from the team.",
"htmlTemplate": "Thanks {{firstName}}!
"}}
]
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
```
```javascript JavaScript theme={null}
const emailDefaults = {
senderEmail: 'team@example.com',
senderName: 'Example Team',
projectId: '60d5ec49f1b2c72d9c8b1111'
};
const payload = {
name: 'Branch with guard - pro vs other',
description: 'Pro plan gets a 2-email sequence with a guard. Other plans get a single welcome email.',
active: true,
entryCriteria: {
type: 'contact_property_matches_with',
filterCriteria: {
logicalOperator: 'AND',
groups: [
{ field: 'customFields.plan', operator: 'is_not_empty', id: 'filter_1', fieldType: 'string' }
]
}
},
unsubscribeGroupId: '60d5ec49f1b2c72d9c8b4444',
trackingOpen: true,
trackingClick: true,
exitCriteria: { type: 'workflow_complete' },
tags: ['onboarding', 'branch-guard'],
steps: [
{ type: 'wait', delay: { value: 2, unit: 'mins' }, checkExitCriteria: true,
stepId: 'step_wait_intro', nextStepId: 'step_email_intro' },
{ type: 'email',
email: { ...emailDefaults, templateName: 'Welcome - intro email',
subject: 'Welcome to Example!', previewText: 'Glad to have you with us.',
htmlTemplate: 'Welcome {{firstName}}!
' },
checkExitCriteria: true, stepId: 'step_email_intro', nextStepId: 'step_branch' },
{ stepId: 'step_branch', type: 'branch', branches: [
{ branchId: 'br_pro', label: 'Pro plan',
triggerType: 'contact_property_matches_with', appliesTo: 'all_branch_steps',
filterCriteria: { logicalOperator: 'AND', groups: [
{ field: 'customFields.plan', operator: 'equals', value: 'pro', id: 'filter_2', fieldType: 'string' }
]},
nextStepId: 'step_wait_pro', mergeStepId: 'step_wait_merged' },
{ branchId: 'br_other', label: 'Catch-all',
triggerType: 'contact_property_matches_with', appliesTo: 'branch_entry',
filterCriteria: { logicalOperator: 'AND', groups: [
{ field: 'customFields.plan', operator: 'is_not_empty', id: 'filter_3', fieldType: 'string' }
]},
nextStepId: 'step_wait_other' }
]},
{ type: 'wait', delay: { value: 2, unit: 'mins' }, checkExitCriteria: true,
stepId: 'step_wait_pro', parentBranchStepId: 'step_branch', parentBranchId: 'br_pro',
nextStepId: 'step_email_pro' },
{ stepId: 'step_email_pro', type: 'email',
email: { ...emailDefaults, templateName: 'Welcome - pro email',
subject: 'Welcome to Pro, {{firstName}}', previewText: 'Your Pro perks are ready.',
htmlTemplate: 'Welcome to Pro!
' },
parentBranchStepId: 'step_branch', parentBranchId: 'br_pro',
nextStepId: 'step_wait_pro_followup' },
{ stepId: 'step_wait_pro_followup', type: 'wait', delay: { value: 1, unit: 'minutes' },
parentBranchStepId: 'step_branch', parentBranchId: 'br_pro',
nextStepId: 'step_email_pro_followup' },
{ stepId: 'step_email_pro_followup', type: 'email',
email: { ...emailDefaults, templateName: 'Welcome - pro follow-up',
subject: 'A quick follow-up on your Pro plan', previewText: 'Tips to get the most out of Pro.',
htmlTemplate: 'Hi {{firstName}}
' },
parentBranchStepId: 'step_branch', parentBranchId: 'br_pro' },
{ stepId: 'step_wait_other', type: 'wait', delay: { value: 2, unit: 'mins' },
checkExitCriteria: true, parentBranchStepId: 'step_branch',
parentBranchId: 'br_other', nextStepId: 'step_email_other' },
{ stepId: 'step_email_other', type: 'email',
email: { ...emailDefaults, templateName: 'Welcome - standard email',
subject: 'Welcome to Example!', previewText: 'Glad to have you with us.',
htmlTemplate: 'Welcome {{firstName}}!
' },
parentBranchStepId: 'step_branch', parentBranchId: 'br_other' },
{ stepId: 'step_wait_merged', type: 'wait', delay: { value: 2, unit: 'mins' },
checkExitCriteria: true, nextStepId: 'step_email_merged' },
{ stepId: 'step_email_merged', type: 'email',
email: { ...emailDefaults, templateName: 'Welcome - merged email',
subject: 'Thanks for sticking with us, {{firstName}}',
previewText: 'A wrap-up note from the team.',
htmlTemplate: 'Thanks {{firstName}}!
' }}
]
};
fetch('https://api.autosend.com/v1/automations', {
method: 'POST',
headers: {
'Authorization': 'Bearer AS_your-project-api-key',
'Content-Type': 'application/json'
},
body: JSON.stringify(payload)
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error('Error:', error));
```
```php PHP theme={null}
```
```go Go theme={null}
package main
import (
"bytes"
"fmt"
"io"
"net/http"
"os"
)
func main() {
// Load the workflow payload (see the cURL or JavaScript example for the full structure).
body, _ := os.ReadFile("automation.json")
req, _ := http.NewRequest("POST", "https://api.autosend.com/v1/automations", bytes.NewBuffer(body))
req.Header.Set("Authorization", "Bearer AS_your-project-api-key")
req.Header.Set("Content-Type", "application/json")
resp, err := (&http.Client{}).Do(req)
if err != nil {
fmt.Println("Error:", err)
return
}
defer resp.Body.Close()
out, _ := io.ReadAll(resp.Body)
fmt.Println(string(out))
}
```
```java Java theme={null}
import java.io.OutputStream;
import java.net.HttpURLConnection;
import java.net.URL;
import java.nio.file.Files;
import java.nio.file.Paths;
public class CreateWorkflow {
public static void main(String[] args) throws Exception {
// Load the workflow payload (see the cURL or JavaScript example for the full structure).
byte[] body = Files.readAllBytes(Paths.get("automation.json"));
HttpURLConnection con = (HttpURLConnection) new URL("https://api.autosend.com/v1/automations").openConnection();
con.setRequestMethod("POST");
con.setRequestProperty("Authorization", "Bearer AS_your-project-api-key");
con.setRequestProperty("Content-Type", "application/json");
con.setDoOutput(true);
try (OutputStream os = con.getOutputStream()) {
os.write(body);
}
System.out.println("Response Status: " + con.getResponseCode());
}
}
```
```ruby Ruby theme={null}
require 'net/http'
require 'uri'
uri = URI('https://api.autosend.com/v1/automations')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Post.new(uri.path)
request['Authorization'] = 'Bearer AS_your-project-api-key'
request['Content-Type'] = 'application/json'
# Load the workflow payload (see the cURL or JavaScript example for the full structure).
request.body = File.read('automation.json')
puts http.request(request).body
```
```json 201 Response theme={null}
{
"success": true,
"data": {
"id": "60d5ec49f1b2c72d9c8b9abc",
"projectId": "60d5ec49f1b2c72d9c8b1111",
"organizationId": "60d5ec49f1b2c72d9c8b2222",
"name": "Branch with guard - pro vs other",
"description": "Pro plan gets a 2-email sequence with a guard. Other plans get a single welcome email.",
"status": "active",
"entryCriteria": {
"type": "contact_property_matches_with",
"filterCriteria": {
"logicalOperator": "AND",
"groups": [
{ "field": "customFields.plan", "operator": "is_not_empty", "id": "filter_1", "fieldType": "string" }
]
}
},
"exitCriteria": { "type": "workflow_complete" },
"steps": [
{ "stepId": "step_wait_intro", "type": "wait", "delay": { "value": 2, "unit": "mins" }, "nextStepId": "step_email_intro" },
{ "stepId": "step_email_intro", "type": "email", "nextStepId": "step_branch" },
{ "stepId": "step_branch", "type": "branch", "branches": [
{ "branchId": "br_pro", "nextStepId": "step_wait_pro", "mergeStepId": "step_wait_merged" },
{ "branchId": "br_other", "nextStepId": "step_wait_other" }
]},
{ "stepId": "step_wait_pro", "type": "wait", "parentBranchId": "br_pro", "nextStepId": "step_email_pro" },
{ "stepId": "step_email_pro", "type": "email", "parentBranchId": "br_pro", "nextStepId": "step_wait_pro_followup" },
{ "stepId": "step_wait_pro_followup", "type": "wait", "parentBranchId": "br_pro", "nextStepId": "step_email_pro_followup" },
{ "stepId": "step_email_pro_followup", "type": "email", "parentBranchId": "br_pro" },
{ "stepId": "step_wait_other", "type": "wait", "parentBranchId": "br_other", "nextStepId": "step_email_other" },
{ "stepId": "step_email_other", "type": "email", "parentBranchId": "br_other" },
{ "stepId": "step_wait_merged", "type": "wait", "nextStepId": "step_email_merged" },
{ "stepId": "step_email_merged", "type": "email" }
],
"tags": ["onboarding", "branch-guard"],
"unsubscribeGroupId": "60d5ec49f1b2c72d9c8b4444",
"trackingOpen": true,
"trackingClick": true,
"activeAt": "2026-05-08T10:00:00.000Z",
"createdAt": "2026-05-08T10:00:00.000Z",
"updatedAt": "2026-05-08T10:00:00.000Z"
}
}
```
***
#### Authorizations
Project API key header of the form Bearer `AS_`.
### Body
Display name for the workflow automation.
Maximum length: `255`
Example: `"Welcome Series"`
Optional description.
Maximum length: `1000`
Defines which contacts enter the workflow.
One of `contact_created`, `contact_added_to_list`, `contact_property_matches_with`, `contact_property_changes_from_to`, or `event_trigger`. Defaults to `contact_created`.
ID of the contact list or segment.
Required when `type` is `event_trigger`. Name of the event that triggers the workflow.
Optional filter tree applied on top of the base `type`. Use `event.name` and `event.properties.*` paths in `event_trigger` workflows; otherwise reference contact properties.
```json theme={null}
{
"logicalOperator": "AND",
"groups": [
{
"field": "source",
"operator": "contains",
"value": "web",
"id": "filter_1"
}
]
}
```
source is a Custom Field
Defines when contacts leave the workflow before completion.
One of `workflow_complete` (default), `entry_criteria_no_longer_met`.
Ordered steps that contacts walk through. Each step must include a `type`. Linear workflows alternate `wait` and `email`; workflows containing a `branch` step form a graph where each step references the next via `nextStepId`. Every `email` step must be preceded by a `wait` step (use a delay of `0` to send immediately), including email steps inside a branch.
One of `wait`, `email`, or `branch`.
Required for `wait` steps. `delay.value` is a non-negative integer; `delay.unit` is one of `minutes`, `mins`, `hours`, or `days`.
Required for `email` steps. Provide either `templateId` (existing template) or `htmlTemplate` (inline HTML, `subject` is required when using `htmlTemplate`). Optional fields: `subject`, `previewText`, `senderEmail`, `senderName`, `senderReplyToEmail`, `senderReplyToName`.
Required for `branch` steps. Each branch defines a `triggerType` (`contact_property_matches_with` or `event_property`), a `filterCriteria` tree, an `appliesTo` scope (`branch_entry` or `all_branch_steps`), a `nextStepId` that points to the first step on that branch, and an optional `mergeStepId` where the branch rejoins the main flow.
ID of the next step in graph-style workflows (those containing a `branch`). Steps inside a branch must also set `parentBranchStepId` and `parentBranchId`.
Whether to re-evaluate exit criteria before this step. Defaults to `true`.
#### Branch step example
A `branch` step splits the workflow into multiple paths based on `filterCriteria`. Each branch points at its first step via `nextStepId`, and steps inside the branch reference back via `parentBranchStepId` and `parentBranchId`. Branches can rejoin the main flow at a shared `mergeStepId`.
```json Branch step theme={null}
{
"stepId": "step_branch",
"type": "branch",
"branches": [
{
"branchId": "br_pro",
"label": "Pro plan",
"triggerType": "contact_property_matches_with",
"appliesTo": "all_branch_steps",
"filterCriteria": {
"logicalOperator": "AND",
"groups": [
{
"field": "customFields.plan",
"operator": "equals",
"value": "pro",
"id": "filter_2",
"fieldType": "string"
}
]
},
"nextStepId": "step_wait_pro",
"mergeStepId": "step_wait_merged"
},
{
"branchId": "br_other",
"label": "Catch-all",
"triggerType": "contact_property_matches_with",
"appliesTo": "branch_entry",
"filterCriteria": {
"logicalOperator": "AND",
"groups": [
{
"field": "customFields.plan",
"operator": "is_not_empty",
"id": "filter_3",
"fieldType": "string"
}
]
},
"nextStepId": "step_wait_other"
}
]
},
```
```json Wait step inside a branch theme={null}
{
"stepId": "step_wait_vip",
"type": "wait",
"delay": { "value": 2, "unit": "mins" },
"checkExitCriteria": true,
"parentBranchStepId": "step_branch",
"parentBranchId": "br_vip",
"nextStepId": "step_email_vip"
}
```
```json Email step inside a branch theme={null}
{
"stepId": "step_email_vip",
"type": "email",
"email": {
"senderEmail": "ankban@mail4.ankitbansal.co.in",
"senderName": "Example Team",
"projectId": "68b7f9dfb6924068b8ecda65",
"templateName": "VIP thank you",
"subject": "A personal thank-you, {{firstName}}",
"previewText": "VIP perks inside.",
"htmlTemplate": "Thanks {{firstName}}!
Your VIP perks are on the way.
"
},
"parentBranchStepId": "step_branch",
"parentBranchId": "br_vip"
}
```
In an `email` step you can pass `templateId` to reference an existing template instead of inlining `htmlTemplate` and `subject`.
Optional tags for filtering and organization.
Suppression group applied to all email steps in the workflow.
Whether to insert open-tracking pixels into emails sent by this workflow.
Whether to rewrite links for click tracking in emails sent by this workflow.
When `true`, the workflow is validated and activated as part of the create call. When `false` or omitted, the workflow is created in `draft` status and must be activated separately.
#### Response
Workflow automation created successfully (201)
Example: `true`
The created workflow automation.
Unique workflow identifier.
Project the workflow belongs to.
Display name of the workflow.
Optional description.
Current status: `draft`, `active`, `paused`, or `archived`.
Conditions that determine which contacts enter the workflow.
Conditions that cause contacts to exit the workflow early.
Resolved steps with auto-generated `stepId` values.
Tags for filtering and organization.
Suppression group applied to all email steps in the workflow.
Whether open tracking is enabled.
Whether click tracking is enabled.
ISO 8601 timestamp when the workflow was last activated, or `null` if never activated.
ISO 8601 creation timestamp.
Organization the workflow belongs to.
ISO 8601 last-updated timestamp.
#### Error Responses
Returned when the request body fails validation. Common codes include `NAME_REQUIRED`, `INVALID_STEP_SEQUENCE`, `EMAIL_TEMPLATE_REQUIRED`, `BRANCH_BRANCHES_REQUIRED`, `EVENT_NAME_REQUIRED`.
```json theme={null}
{
"success": false,
"error": {
"message": "Steps must strictly alternate wait → email starting with wait and ending with email",
"code": "INVALID_STEP_SEQUENCE"
}
}
```
Returned when `active: true` is sent but the workflow is missing required fields for activation.
```json theme={null}
{
"success": false,
"error": {
"message": "Cannot activate workflow. Please check all required fields are filled",
"code": "CANNOT_ACTIVATE_AUTOMATION"
}
}
```
## OpenAPI
````yaml POST /automations
openapi: 3.1.0
info:
title: AutoSend API
description: >-
AutoSend REST API for managing workflow automations. Workflow automations
send a sequence of emails to contacts based on entry criteria (contact
created, added to a list, segment match, contact-property match,
contact-property change, or a custom event). These endpoints accept a
standard project API key (AS_ prefix).
version: 1.0.0
servers:
- url: https://api.autosend.com/v1
security:
- bearerAuth: []
paths:
/automations:
post:
summary: Create Automation
description: >-
Creates a new workflow automation. Pass `active: true` to activate the
workflow as part of the create call.
components: {}
````
## Related topics
- [AutoSend MCP Server](/ai/mcp-server.md)
- [Update Automation](/api-reference/automations/update-automation.md)
- [How to Create an Email Automation](/automations/create.md)
- [Email Automations](/automations.md)
- [Changelog](/changelog.md)