Skip to main content
POST

Authorizations

Authorization
string
header
required

Your Mailercloud API key (plain text, no Bearer prefix). Create keys in Settings → API.

Headers

Content-Type
string
default:application/json
required

Request body type

Body

application/json
name
string
required

Automation display name. HTML is stripped server-side.

Minimum: 1 Maximum: 150

Required string length: 1 - 150
nodes
object[]
required

DAG of trigger + downstream action / condition nodes. Exactly one trigger node is required; no orphans and no cycles allowed.

Minimum items: 1 Maximum items: 500

Required array length: 1 - 500 elements
timezone
string

IANA timezone (e.g. Asia/Kolkata, America/New_York, UTC). Defaults to the caller's account timezone.

auto_publish
boolean
default:false

If true, the automation is published immediately and the response returns status=active. If false (default), it is saved as a draft and returns status=draft.

allow_re_enrollment
boolean
default:false

Allow the same contact to re-enter this automation after completing or exiting.

re_enroll_interval
integer

Minimum wait before a contact can re-enroll. Required when allow_re_enrollment is true.

Minimum: 1 Maximum: 30

Required range: 1 <= x <= 30
re_enroll_unit
enum<string>

Unit for re_enroll_interval. Required when allow_re_enrollment is true.

Supported values: hours, days, weeks

Available options:
hours,
days,
weeks
start_time
string

Earliest UTC moment the automation will accept new contacts.

Format: YYYY-MM-DD HH:mm:ss

Must be in the future.

end_time
string

Latest UTC moment the automation will accept new contacts.

Format: YYYY-MM-DD HH:mm:ss

Must be in the future and >= start_time.

Response

Created

status
enum<string>

draft when auto_publish=false. active when auto_publish=true and all publish gates pass.

Available options:
draft,
active