Automations
Every operation in this group: what it accepts, what it returns and the errors it can answer with.
Operations
Emails and other steps that run by themselves for each contact: a welcome series when somebody joins an audience, a nudge three days after a trial starts, a note on a birthday. An automation has a trigger, which says what puts a contact in, and steps: send an email from a template, wait, branch on what the contact did, add them to or remove them from an audience, write a custom field, call a webhook, or end.
You edit a draft definition and publish it. Publishing saves a numbered version and sets the automation live, and each contact stays on the version they entered on, so an edit never changes the path of somebody halfway through. Settings apply as soon as they are saved. A plan covers a number of live automations: 1 on Free, 10 on Starter and 50 on Business, with no limit on Enterprise.
Every email it sends goes out on the broadcast lane with a one-click unsubscribe, counts toward the monthly sends and skips suppressed addresses. Publishing, resuming and sending a test also need emails:send, because the automation then sends mail for whoever published it. Reading needs automations:read and everything else automations:write.
GET/automations
List automations
Every automation in the workspace, the most recently saved first, without the definition or settings. counts is counted at the moment of the read.
An app a member connected lists only the automations that member made.
Requires the automations:read scope.
Query parameters
statusstringOnly automations in this state.
One of"draft""live""paused""archived"limitintegerRows per page, 1 to 100.
At least 1At most 100Default50cursorstringThe id of the last automation on the previous page. Keyset, not offset: pass the previous page's
nextCursor. One that names nothing in this list is a 400invalid_cursor.
Returns
A page of automations.
Errors
The errors every operation can return400401403404422500Error catalog
Also available in
- TypeScript
automations.list()automations.listAll()automations.iterate()- Python
automations.list()automations.list_all()automations.iterate()- Ruby
automations.listautomations.list_allautomations.iterate- PHP
automations->listautomations->listAllautomations->iterate- Go
Automations.ListAutomations.ListAllAutomations.Iterate- Java
automations().listautomations().listAllautomations().iterate- C#
Automations.ListAsyncAutomations.ListAllAsyncAutomations.IterateAsync- CLI
openemail automations list- MCP
listAutomations
POST/automations
Create an automation
Makes a draft from definition, from a starter, or empty when neither is sent, and answers with the whole automation. A draft may be incomplete: problems in the answer lists what is still missing, and nothing runs until POST /automations/{id}/publish.
Requires the automations:write scope.
Request body
namestringRequiredWhat the workspace calls the automation, trimmed, 1 to 120 characters. Contacts never see it, and it need not be unique.
1 to 120 charactersdescriptionstringA note for the workspace, at most 500 characters. Contacts never see it.
Can be nullUp to 500 charactersstarterstringBegin from a starter, by its
slug:welcome-series,trial-follow-up,birthdayorwin-back. Ignored whendefinitionis sent. A starter leaves the audience, the templates and the from address for you to fill in.1 to 64 charactersdefinitionobjectWhat starts an automation and what it then does. Paths never join or loop: every step is reached from exactly one place, and a definition holds at most 50 steps.
triggerobjectRequiredWhat puts a contact into the automation. Null in a draft that has none yet, and a draft cannot be published without one.
Can be nullkindstringRequired- One of
"audience_joined" audienceIdstringRequired- Up to 64 characters
includeImportedbooleanRequired
entrystringRequiredThe
keyof the first step, or null while the draft has no steps.Can be nullPattern^[a-z][a-z0-9]{2,23}$stepsobject[]RequiredEvery step, in any order. Each has a unique
key, and names the step after it by key innext, or inyesandnofor a branch. Null ends the path there.Up to 50 itemskeystringRequired- Pattern
^[a-z][a-z0-9]{2,23}$ namestring- Up to 80 characters
kindstringRequired- One of
"send_email" nextstringRequired- Can be nullPattern
^[a-z][a-z0-9]{2,23}$ templateIdstringRequired- Up to 64 characters
templateVersionintegerRequired- Can be nullAt least 1
fromobjectRequiredemailstringRequired- Up to 320 characters
namestring- Up to 120 characters
replyTostringRequired- Can be nullUp to 320 characters
subjectstringRequired- Can be nullUp to 300 characters
propsRecord<string, object>Required
settingsobjectHow the automation runs:
timezone, an IANA zone such asEurope/London,sendWindow, the days and minutes of the day in which emails may go out or null for any time,reentryDays, how many days after finishing a contact may enter again or null for once only,exitOnLeave, whether a contact leaves when they leave the audience that started it, andlistAudienceId, the audience unsubscribes are recorded in. Every field is optional.timezonestring- 1 to 64 characters
sendWindowobject- Can be null
daysinteger[]Required- Up to 7 items
startMinuteintegerRequired- At least 0At most 1440
endMinuteintegerRequired- At least 0At most 1440
reentryDaysinteger- Can be nullAt least 1At most 3650
exitOnLeavebooleanlistAudienceIdstring- Can be nullUp to 64 characters
Returns
Created, as a draft.
Errors
- 422
invalid_parameterfor a value of the wrong shape,unknown_parameterfor a key the body does not take,invalid_automationfor an unknownstarteror a definition that breaks a rule of its structure, such as two steps with one key, orworkspace_limit_reachedwhen the workspace holds the most automations it may.
The errors every operation can return400401403404500Error catalog
Also available in
GET/automations/starters
List the automation starters
The starting points the app offers when somebody makes an automation, each with its whole definition. Not paginated and not workspace data. The slug is what POST /automations takes as starter. A starter leaves the audience, the templates and the from address empty for you to fill in.
Requires the automations:read scope.
Returns
Every starter.
Errors
The errors every operation can return400401403404422500Error catalog
Also available in
GET/automations/{id}
Retrieve an automation
The whole automation: the draft definition, the published definition that is running, settings, fresh counts and problems, what would stop the draft from being published. An automation in another workspace is a 404, never a 403.
Requires the automations:read scope.
Path parameters
idstringRequiredThe automation, such as
aut_5c1e9a7b3d2f48e6a0b4c7d1, asGET /automationslists it.
Returns
The automation.
Errors
- 404
automation_not_foundwhen the id names no automation you can reach.
The errors every operation can return400401403422500Error catalog
Also available in
PATCH/automations/{id}
Update an automation
A partial update. definition replaces the draft whole, and a live automation keeps running its published version until POST /automations/{id}/publish. settings is merged field by field and takes effect at once.
Read the automation, change it and send expectedUpdatedAt with the updatedAt you read: if someone saved it in between, your change is refused instead of written over theirs.
Requires the automations:write scope.
Path parameters
idstringRequiredThe automation, such as
aut_5c1e9a7b3d2f48e6a0b4c7d1, asGET /automationslists it.
Request body
namestringWhat the workspace calls the automation, trimmed, 1 to 120 characters. Contacts never see it, and it need not be unique.
1 to 120 charactersdescriptionstringA note for the workspace, at most 500 characters. Contacts never see it.
Can be nullUp to 500 charactersdefinitionobjectWhat starts an automation and what it then does. Paths never join or loop: every step is reached from exactly one place, and a definition holds at most 50 steps.
triggerobjectRequiredWhat puts a contact into the automation. Null in a draft that has none yet, and a draft cannot be published without one.
Can be nullkindstringRequired- One of
"audience_joined" audienceIdstringRequired- Up to 64 characters
includeImportedbooleanRequired
entrystringRequiredThe
keyof the first step, or null while the draft has no steps.Can be nullPattern^[a-z][a-z0-9]{2,23}$stepsobject[]RequiredEvery step, in any order. Each has a unique
key, and names the step after it by key innext, or inyesandnofor a branch. Null ends the path there.Up to 50 itemskeystringRequired- Pattern
^[a-z][a-z0-9]{2,23}$ namestring- Up to 80 characters
kindstringRequired- One of
"send_email" nextstringRequired- Can be nullPattern
^[a-z][a-z0-9]{2,23}$ templateIdstringRequired- Up to 64 characters
templateVersionintegerRequired- Can be nullAt least 1
fromobjectRequiredemailstringRequired- Up to 320 characters
namestring- Up to 120 characters
replyTostringRequired- Can be nullUp to 320 characters
subjectstringRequired- Can be nullUp to 300 characters
propsRecord<string, object>Required
settingsobjectMerged field by field into the stored settings, and applied at once, without publishing. Send only the fields you are changing.
timezonestring- 1 to 64 characters
sendWindowobject- Can be null
daysinteger[]Required- Up to 7 items
startMinuteintegerRequired- At least 0At most 1440
endMinuteintegerRequired- At least 0At most 1440
reentryDaysinteger- Can be nullAt least 1At most 3650
exitOnLeavebooleanlistAudienceIdstring- Can be nullUp to 64 characters
expectedUpdatedAtstringThe
updatedAtyou read. When the automation was saved since, the call is refused with 409version_conflictand nothing is written.Formatdate-time
Returns
Saved.
Errors
- 404
automation_not_foundwhen the id names no automation you can reach.- 409
version_conflict: the automation was saved afterexpectedUpdatedAt.automation_archived: an archived automation cannot be changed. Nothing was written.- 422
invalid_parameterfor a value of the wrong shape,unknown_parameterfor a key the body does not take, orinvalid_automationwhen the definition breaks a rule of its structure orsettings.listAudienceIdnames no audience.
The errors every operation can return400401403500Error catalog
Also available in
DELETE/automations/{id}
Delete an automation
Deletes the automation with its versions, its enrollments and its statistics. Contacts in it stop at once and get nothing more. The emails it already sent stay in GET /emails.
There is no undo. To retire one and keep its history, use POST /automations/{id}/archive.
Requires the automations:write scope.
Path parameters
idstringRequiredThe automation, such as
aut_5c1e9a7b3d2f48e6a0b4c7d1, asGET /automationslists it.
Returns
Deleted.
Errors
- 403
The key lacks the scope, or may not send as that address.
step_up_required: the call was made with an OAuth access token that has not been verified in the last 60 minutes. Ask for a code withPOST /security/step-up, send it toPOST /security/step-up/verify, then repeat the call. The person can also choose Allow changes for 60 minutes on the app in Account settings, Connected apps, on the OpenEmail website. An API key is never asked for a code.- 404
automation_not_foundwhen the id names no automation you can reach.
The errors every operation can return400401422500Error catalog
Also available in
POST/automations/{id}/publish
Publish an automation
Saves the draft as the next version and sets the automation live, so its trigger starts taking contacts in. Contacts already in it stay on the version they entered on. Publishing a paused automation turns it back on. No body.
The draft has to be complete: a trigger, at least one step, every email with a published template that declares unsubscribeUrl and a from address the caller may send as, and every audience, form and webhook it names still there. The automation sends as whoever published it, so it pauses itself if that API key is revoked.
Requires the automations:write and emails:send scopes.
Path parameters
idstringRequiredThe automation, such as
aut_5c1e9a7b3d2f48e6a0b4c7d1, asGET /automationslists it.
Returns
Published and live.
Errors
- 403
automation_limit_reachedwhen the plan covers no more live automations, orinsufficient_scope.- 404
automation_not_foundwhen the id names no automation you can reach.- 409
automation_archived: an archived automation cannot be published.- 422
invalid_automationwhen the draft cannot run: the error carriesproblems, every problem that blocks it, each with acode, thepathof the field, thestepKeyand amessage.
The errors every operation can return400401500Error catalog
Also available in
POST/automations/{id}/pause
Pause an automation
Stops a live automation. Nobody new enters, and everyone in it stays where they are and moves on when it is resumed. Pausing a paused automation changes nothing. No body.
Requires the automations:write scope.
Path parameters
idstringRequiredThe automation, such as
aut_5c1e9a7b3d2f48e6a0b4c7d1, asGET /automationslists it.
Returns
Paused.
Errors
- 404
automation_not_foundwhen the id names no automation you can reach.- 409
automation_not_published: a draft that was never published cannot be paused.automation_archived: neither can an archived one.
The errors every operation can return400401403422500Error catalog
Also available in
POST/automations/{id}/resume
Resume an automation
Turns a paused automation back on with the version it was running, without publishing the draft. Contacts that were held move on, and from now on it sends as the caller. The published version is checked again first, so an automation OpenEmail paused stays paused until what stopped it is fixed. Resuming a live automation changes nothing. No body.
Requires the automations:write and emails:send scopes.
Path parameters
idstringRequiredThe automation, such as
aut_5c1e9a7b3d2f48e6a0b4c7d1, asGET /automationslists it.
Returns
Live again.
Errors
- 403
automation_limit_reachedwhen the plan covers no more live automations, orinsufficient_scope.- 404
automation_not_foundwhen the id names no automation you can reach.- 409
automation_not_published: there is no published version to resume.automation_archived: an archived automation cannot be resumed.- 422
invalid_automationwhen the draft cannot run: the error carriesproblems, every problem that blocks it, each with acode, thepathof the field, thestepKeyand amessage.
The errors every operation can return400401500Error catalog
Also available in
POST/automations/{id}/archive
Archive an automation
Retires an automation for good and keeps its history. Everyone in it leaves with the exit reason archived, nobody enters again, and it can no longer be changed, published or resumed. Its versions, enrollments and statistics stay readable. Archiving an archived automation changes nothing. No body.
To start again from its steps, use POST /automations/{id}/duplicate.
Requires the automations:write scope.
Path parameters
idstringRequiredThe automation, such as
aut_5c1e9a7b3d2f48e6a0b4c7d1, asGET /automationslists it.
Returns
Archived.
Errors
- 404
automation_not_foundwhen the id names no automation you can reach.
The errors every operation can return400401403422500Error catalog
Also available in
POST/automations/{id}/duplicate
Duplicate an automation
Makes a new draft with the same draft definition and settings, named after the original with (copy) on the end. The copy has no versions, no contacts and no statistics. No body.
Requires the automations:write scope.
Path parameters
idstringRequiredThe automation, such as
aut_5c1e9a7b3d2f48e6a0b4c7d1, asGET /automationslists it.
Returns
The copy, as a draft.
Errors
- 404
automation_not_foundwhen the id names no automation you can reach.- 422
workspace_limit_reachedwhen the workspace holds the most automations it may.
The errors every operation can return400401403500Error catalog
Also available in
POST/automations/{id}/test
Send a test of one email step
Sends the email of one step of the draft to one address, so you can read it before publishing. Contact values are filled from a sample contact, values that come from an event are left empty, and the subject starts with [Test]. It counts toward the monthly sends, is not tracked and enrolls nobody.
Requires the automations:write and emails:send scopes.
Path parameters
idstringRequiredThe automation, such as
aut_5c1e9a7b3d2f48e6a0b4c7d1, asGET /automationslists it.
Request body
stepKeystringRequiredThe
keyof the email step to send, from the draftdefinition.1 to 64 characterstostringWhere the test goes. Left out, it goes to the account email of the person the key or app acts for.
Up to 320 charactersFormatemail
Returns
Sent.
Errors
- 403
from_address_forbiddenwhen the caller may not send as the from address of the step, orinsufficient_scope.- 404
automation_not_foundwhen the id names no automation you can reach.- 409
domain_not_sendablewhen the domain of the from address cannot send yet.- 422
invalid_automationwhenstepKeynames no step, the step is not an email, or its template cannot be sent, withparamset tostepKey.- 429
send_quota_exceeded: the monthly sends of the plan are used up.
The errors every operation can return400401500Error catalog
Also available in
GET/automations/{id}/versions
List the versions of an automation
Every published version, the newest first, each with its whole definition. current marks the one that is running. Not paginated. A draft that was never published has none.
Requires the automations:read scope.
Path parameters
idstringRequiredThe automation, such as
aut_5c1e9a7b3d2f48e6a0b4c7d1, asGET /automationslists it.
Returns
The versions.
Errors
- 404
automation_not_foundwhen the id names no automation you can reach.
The errors every operation can return400401403422500Error catalog
Also available in
POST/automations/{id}/versions/{version}/restore
Restore a version into the draft
Copies the definition of an earlier version into the draft, replacing what the draft holds. Nothing that is running changes until POST /automations/{id}/publish. No body.
Requires the automations:write scope.
Path parameters
idstringRequiredThe automation, such as
aut_5c1e9a7b3d2f48e6a0b4c7d1, asGET /automationslists it.versionintegerRequiredThe number of the version, as
GET /automations/{id}/versionslists it.At least 1
Returns
The automation, with the version in its draft.
Errors
- 404
automation_not_foundwhen the id names no automation you can reach, or, withparamset toversion, when it has no such version.- 409
automation_archived: an archived automation cannot be changed.
The errors every operation can return400401403422500Error catalog
Also available in
GET/automations/{id}/stats
How an automation has performed
Totals for a window, the same numbers step by step, and a point per day. The steps are those of the published version, or of the draft when nothing is published. active and waiting are counted at the moment of the read, whatever the window.
Requires the automations:read scope.
Path parameters
idstringRequiredThe automation, such as
aut_5c1e9a7b3d2f48e6a0b4c7d1, asGET /automationslists it.
Query parameters
sincestringWhere the window starts, as an ISO 8601 instant. Left out, 30 days before
until. It reaches back at most 366 days beforeuntil.Formatdate-timeuntilstringWhere the window ends, as an ISO 8601 instant. Left out, now.
Formatdate-time
Returns
The numbers for the window.
Errors
- 404
automation_not_foundwhen the id names no automation you can reach.- 422
invalid_parameterwhen a time is not an ISO 8601 instant oruntilis not aftersince.
The errors every operation can return400401403500Error catalog
Also available in
GET/automations/{id}/enrollments
List the contacts in an automation
Everyone who is in the automation or has been, the most recent entry first: where each contact is, what they are waiting for and how it ended.
Requires the automations:read scope.
Path parameters
idstringRequiredThe automation, such as
aut_5c1e9a7b3d2f48e6a0b4c7d1, asGET /automationslists it.
Query parameters
statusstringOnly enrollments in this state.
One of"active""completed""exited"stepKeystringOnly contacts at the step with this
key.1 to 64 charactersqstringOnly contacts whose address or name contains this text, compared without case.
Up to 200 characterslimitintegerRows per page, 1 to 200.
At least 1At most 200Default50cursorstringThe id of the last enrollment on the previous page. Keyset, not offset: pass the previous page's
nextCursor. One that names nothing in this list is a 400invalid_cursor.
Returns
A page of enrollments.
Errors
- 404
automation_not_foundwhen the id names no automation you can reach.
The errors every operation can return400401403422500Error catalog
Also available in
- TypeScript
automations.listEnrollments()automations.listAllEnrollments()automations.iterateEnrollments()- Python
automations.list_enrollments()automations.list_all_enrollments()automations.iterate_enrollments()- Ruby
automations.list_enrollmentsautomations.list_all_enrollmentsautomations.iterate_enrollments- PHP
automations->listEnrollmentsautomations->listAllEnrollmentsautomations->iterateEnrollments- Go
Automations.ListEnrollmentsAutomations.ListAllEnrollmentsAutomations.IterateEnrollments- Java
automations().listEnrollmentsautomations().listAllEnrollmentsautomations().iterateEnrollments- C#
Automations.ListEnrollmentsAsyncAutomations.ListAllEnrollmentsAsyncAutomations.IterateEnrollmentsAsync- CLI
openemail automations list-enrollments- MCP
listAutomationEnrollments
POST/automations/{id}/enrollments
Enroll a contact in an automation
Puts one contact into a live automation at its first step, whatever its trigger is. The contact has to exist already. data gives the steps the values they would otherwise read from an event.
A contact is in an automation once at a time, and comes back in only after settings.reentryDays. An address on the suppression list, or one that unsubscribed from the audience the automation sends through, is refused.
Requires the automations:write scope.
Path parameters
idstringRequiredThe automation, such as
aut_5c1e9a7b3d2f48e6a0b4c7d1, asGET /automationslists it.
Request body
contactIdstringThe contact, by id. Send this or
email, never both.1 to 64 charactersemailstringThe contact, by email address. Send this or
contactId, never both.Up to 320 charactersFormatemaildataRecord<string, any>Values the steps can read wherever a value comes from the event, such as an order number for an email. At most 50 keys and 4 KB of JSON.
Returns
Enrolled, and due at the first step.
Errors
- 404
automation_not_found, orcontact_not_foundwhen no contact has that id or address.- 409
automation_not_livewhen it is a draft, paused or archived.already_enrolledwhen the contact is in it or finished it too recently.contact_unreachablewhen the address is suppressed or unsubscribed.- 422
invalid_parameterwhen neither or both ofcontactIdandemailare sent, ordatais too large.
The errors every operation can return400401403500Error catalog
Also available in
GET/automations/{id}/enrollments/{enrollmentId}
Retrieve an enrollment
One contact's way through the automation: the enrollment, plus runs, what each step did for them, oldest first, up to 200.
Requires the automations:read scope.
Path parameters
idstringRequiredThe automation, such as
aut_5c1e9a7b3d2f48e6a0b4c7d1, asGET /automationslists it.enrollmentIdstringRequiredThe enrollment, such as
aen_2b8d4f6a1c3e5079b6d8f0a2, asGET /automations/{id}/enrollmentslists it.
Returns
The enrollment with its runs.
Errors
The errors every operation can return400401403422500Error catalog
Also available in
POST/automations/{id}/enrollments/{enrollmentId}/exit
Take a contact out of an automation
Ends an active enrollment at once with the exit reason removed. The contact gets nothing more from this automation, and stays in the contacts and in their audiences. No body.
Requires the automations:write scope.
Path parameters
idstringRequiredThe automation, such as
aut_5c1e9a7b3d2f48e6a0b4c7d1, asGET /automationslists it.enrollmentIdstringRequiredThe enrollment, such as
aen_2b8d4f6a1c3e5079b6d8f0a2, asGET /automations/{id}/enrollmentslists it.
Returns
The enrollment, exited.
Errors
- 409
automation_enrollment_finished: the contact already completed or left.
The errors every operation can return400401403422500Error catalog
Also available in
Objects
Automationobject
objectstringRequired- One of
"automation" idstringRequiredThe id of the automation. It never changes.
namestringRequiredWhat the workspace calls it. Contacts never see it.
descriptionstringRequiredA note for the workspace.
Can be nullstatusstringRequireddraftuntil the first publish.livetakes contacts in and moves them along.pausedtakes nobody in and holds everyone where they are.archivedis retired for good and everyone in it has left.One of"draft""live""paused""archived"triggerKindstringRequiredWhat starts the draft, or null while it has no trigger.
Can be nullOne of"audience_joined""form_submitted""event""date""manual"stepCountintegerRequiredHow many steps the draft holds.
At least 0emailCountintegerRequiredHow many of those steps send an email.
At least 0hasUnpublishedChangesbooleanRequiredTrue when the draft differs from the version that is running.
publishedVersionintegerRequiredThe number of the version that is running. Null until the first publish.
Can be nullpausedReasonstringRequiredWhy it is paused.
manualis a person. The others are OpenEmail stopping it:sender_refusedwhen its from address can no longer send,key_revokedwhen the API key that published it was revoked, expired or turned off,template_unavailablewhen one of its templates can no longer be sent,audience_missingwhen an audience it depends on is gone, andplan_limitwhen the plan no longer covers this many live automations. Null while it is not paused.Can be nullOne of"manual""sender_refused""key_revoked""template_unavailable""audience_missing""plan_limit"lastErrorstringRequiredWhat went wrong the last time OpenEmail paused it, in a sentence. Null otherwise.
Can be nullcountsobjectRequiredContacts, counted at the moment of the read.
activeintegerRequiredIn the automation now.
At least 0completedintegerRequiredReached the end of a path, in all its time.
At least 0exitedintegerRequiredLeft before the end, in all its time.
At least 0
createdBystringRequiredThe user id of the person who made it. Null when that account is gone.
Can be nullpublishedAtstringRequiredThe last publish. Null until the first.
Can be nullFormatdate-timepausedAtstringRequiredWhen it was paused. Null while it is not.
Can be nullFormatdate-timearchivedAtstringRequiredWhen it was archived. Null otherwise.
Can be nullFormatdate-timecreatedAtstringRequiredWhen it was made.
Formatdate-timeupdatedAtstringRequiredThe last save. Send it back as
expectedUpdatedAtso a change never overwrites one you have not seen.Formatdate-timedefinitionobjectRequiredWhat starts an automation and what it then does. Paths never join or loop: every step is reached from exactly one place, and a definition holds at most 50 steps.
triggerobjectRequiredWhat puts a contact into the automation. Null in a draft that has none yet, and a draft cannot be published without one.
Can be nullkindstringRequired- One of
"audience_joined" audienceIdstringRequired- Up to 64 characters
includeImportedbooleanRequired
entrystringRequiredThe
keyof the first step, or null while the draft has no steps.Can be nullPattern^[a-z][a-z0-9]{2,23}$stepsobject[]RequiredEvery step, in any order. Each has a unique
key, and names the step after it by key innext, or inyesandnofor a branch. Null ends the path there.Up to 50 itemskeystringRequired- Pattern
^[a-z][a-z0-9]{2,23}$ namestring- Up to 80 characters
kindstringRequired- One of
"send_email" nextstringRequired- Can be nullPattern
^[a-z][a-z0-9]{2,23}$ templateIdstringRequired- Up to 64 characters
templateVersionintegerRequired- Can be nullAt least 1
fromobjectRequiredemailstringRequired- Up to 320 characters
namestring- Up to 120 characters
replyTostringRequired- Can be nullUp to 320 characters
subjectstringRequired- Can be nullUp to 300 characters
propsRecord<string, object>Required
publishedobjectRequiredWhat starts an automation and what it then does. Paths never join or loop: every step is reached from exactly one place, and a definition holds at most 50 steps.
Can be nulltriggerobjectRequiredWhat puts a contact into the automation. Null in a draft that has none yet, and a draft cannot be published without one.
Can be nullkindstringRequired- One of
"audience_joined" audienceIdstringRequired- Up to 64 characters
includeImportedbooleanRequired
entrystringRequiredThe
keyof the first step, or null while the draft has no steps.Can be nullPattern^[a-z][a-z0-9]{2,23}$stepsobject[]RequiredEvery step, in any order. Each has a unique
key, and names the step after it by key innext, or inyesandnofor a branch. Null ends the path there.Up to 50 itemskeystringRequired- Pattern
^[a-z][a-z0-9]{2,23}$ namestring- Up to 80 characters
kindstringRequired- One of
"send_email" nextstringRequired- Can be nullPattern
^[a-z][a-z0-9]{2,23}$ templateIdstringRequired- Up to 64 characters
templateVersionintegerRequired- Can be nullAt least 1
fromobjectRequiredemailstringRequired- Up to 320 characters
namestring- Up to 120 characters
replyTostringRequired- Can be nullUp to 320 characters
subjectstringRequired- Can be nullUp to 300 characters
propsRecord<string, object>Required
settingsobjectRequiredHow it runs. Settings take effect when they are saved, published or not.
timezonestringRequiredThe IANA time zone the sending window and waits until a day and time are read in, such as
Europe/London.UTCuntil you set one.1 to 64 characterssendWindowobjectRequiredWhen emails may go out:
daysof the week (0 is Sunday) andstartMinutetoendMinuteof the day, counted from midnight. An email due outside it waits for the window to open. Null sends at any time.Can be nulldaysinteger[]Required- Up to 7 items
startMinuteintegerRequired- At least 0At most 1440
endMinuteintegerRequired- At least 0At most 1440
reentryDaysintegerRequiredHow many days after a contact finishes before they may enter again. Null lets each contact through once only.
Can be nullAt least 1At most 3650exitOnLeavebooleanRequiredTake a contact out when they leave the audience that started the automation. True by default.
listAudienceIdstringRequiredThe audience an unsubscribe from one of these emails is recorded in. A contact who unsubscribed from it is not sent to and cannot be enrolled. Null uses the audience that starts the automation, or the built-in audience of every contact when no audience starts it.
Can be nullUp to 64 characters
problemsAutomationProblem[]RequiredWhat is wrong with the draft, checked at the moment of the read. Empty when it is ready. A publish checks more: that every template can be sent and that the caller may send from every from address.
AutomationEnrollmentobject
objectstringRequired- One of
"automation_enrollment" idstringRequiredThe id of the enrollment.
automationIdstringRequiredversionintegerRequiredThe published version the contact entered on and stays on. Null when that version is gone.
Can be nullcontactobjectRequiredidstringRequiredThe id of the contact.
emailstringRequired- Format
email namestringRequired- Can be null
statusstringRequiredactivewhile the contact is in it,completedat the end of a path,exitedwhen they left early.One of"active""completed""exited"sourcestringRequiredHow they got in:
trigger, by hand in the app (manual), or through this API or an app (api).One of"trigger""manual""api"stepKeystringRequiredThe
keyof the step the contact is at, or was at when they finished. Null before the first step.Can be nullwaitingbooleanRequiredTrue while the contact sits in a wait step.
waitingForEventstringRequiredThe event name a wait step is holding out for. Null otherwise.
Can be nullheldForstringRequiredWhy a step that is due has not run:
windowfor the sending window,quotafor the monthly sends,lanewhen the broadcast lane of the workspace is paused,retryafter a failure that is tried again. Null when nothing holds it.Can be nullOne of"window""quota""lane""retry"nextRunAtstringRequiredWhen the contact moves next. Null once they finished.
Can be nullFormatdate-timeexitReasonstringRequiredHow it ended:
completed, an exit step (exit_step),unsubscribed,suppressed,left_audience, taken out by a person or a call (removed), the automation wasarchived, or a stepfailedfor good. Null while active.Can be nullOne of"completed""exit_step""unsubscribed""suppressed""left_audience""removed""archived""failed"lastErrorstringRequiredThe last failure of a step, in a sentence.
Can be nullstartedAtstringRequiredWhen the contact entered.
Formatdate-timefinishedAtstringRequiredWhen they completed or left. Null while active.
Can be nullFormatdate-timeupdatedAtstringRequiredThe last time anything about the enrollment changed.
Formatdate-time
AutomationEnrollmentDetailobject
objectstringRequired- One of
"automation_enrollment" idstringRequiredThe id of the enrollment.
automationIdstringRequiredversionintegerRequiredThe published version the contact entered on and stays on. Null when that version is gone.
Can be nullcontactobjectRequiredidstringRequiredThe id of the contact.
emailstringRequired- Format
email namestringRequired- Can be null
statusstringRequiredactivewhile the contact is in it,completedat the end of a path,exitedwhen they left early.One of"active""completed""exited"sourcestringRequiredHow they got in:
trigger, by hand in the app (manual), or through this API or an app (api).One of"trigger""manual""api"stepKeystringRequiredThe
keyof the step the contact is at, or was at when they finished. Null before the first step.Can be nullwaitingbooleanRequiredTrue while the contact sits in a wait step.
waitingForEventstringRequiredThe event name a wait step is holding out for. Null otherwise.
Can be nullheldForstringRequiredWhy a step that is due has not run:
windowfor the sending window,quotafor the monthly sends,lanewhen the broadcast lane of the workspace is paused,retryafter a failure that is tried again. Null when nothing holds it.Can be nullOne of"window""quota""lane""retry"nextRunAtstringRequiredWhen the contact moves next. Null once they finished.
Can be nullFormatdate-timeexitReasonstringRequiredHow it ended:
completed, an exit step (exit_step),unsubscribed,suppressed,left_audience, taken out by a person or a call (removed), the automation wasarchived, or a stepfailedfor good. Null while active.Can be nullOne of"completed""exit_step""unsubscribed""suppressed""left_audience""removed""archived""failed"lastErrorstringRequiredThe last failure of a step, in a sentence.
Can be nullstartedAtstringRequiredWhen the contact entered.
Formatdate-timefinishedAtstringRequiredWhen they completed or left. Null while active.
Can be nullFormatdate-timeupdatedAtstringRequiredThe last time anything about the enrollment changed.
Formatdate-timerunsobject[]RequiredWhat each step did for the contact, oldest first.
idstringRequiredstepKeystringRequiredThe
keyof the step that ran.kindstringRequired- One of
"send_email""wait""branch""add_to_audience""remove_from_audience""update_field""webhook""exit" outcomestringRequiredWhat happened: an email
sent, a waitwaitedout, a branch answeredyesorno, the contactaddedto orremovedfrom an audience, a fieldupdated, a webhookcalled, the pathexited, the stepskipped, or itfailed.One of"sent""skipped""waited""yes""no""added""removed""updated""called""exited""failed"emailIdstringRequiredThe email a send step sent, as
GET /emailslists it. Null for every other step.Can be nulldetailstringRequiredWhy a step was skipped or failed, or how a wait ended.
Can be nullcreatedAtstringRequiredWhen the step ran.
Formatdate-time
AutomationEnrollmentListobject
objectstring- One of
"list" hasMorebooleanTrue when another page follows. Pass
nextCursorback ascursorto read it.nextCursorstringThe id of the last row on this page, or null on the last page.
Can be nullautomationIdstringThe automation the enrollments belong to.
AutomationListobject
objectstring- One of
"list" hasMorebooleanTrue when another page follows. Pass
nextCursorback ascursorto read it.nextCursorstringThe id of the last row on this page, or null on the last page.
Can be null
AutomationProblemobject
codestringRequiredWhat is wrong, for a program to branch on.
One of"trigger_missing""trigger_audience_missing""trigger_form_missing""trigger_event_invalid""trigger_filter_invalid""no_steps""too_many_steps""too_deep""duplicate_key""unknown_target""shared_step""unreachable""template_missing""sender_missing""sender_invalid""reply_to_invalid""wait_invalid""wait_too_long""wait_days_missing""event_name_invalid""condition_step_missing""audience_missing""field_invalid""value_missing""webhook_missing""list_audience_missing""timezone_invalid""window_invalid""template_not_found""template_not_published""template_unsubscribe_missing""template_prop_missing""template_name_required""sender_refused""audience_not_found""audience_is_everyone""form_not_found""webhook_not_found""opens_unreliable"pathstringRequiredThe field at fault, dotted, such as
definition.steps.2.templateIdorsettings.timezone.stepKeystringRequiredThe
keyof the step at fault. Null when it is the trigger or a setting.Can be nullmessagestringRequiredThe problem in a sentence a person can act on.
blockingbooleanRequiredTrue when it stops a publish. False for a warning, such as a branch on opens.
AutomationStarterobject
objectstringRequired- One of
"automation_starter" slugstringRequiredWhat
POST /automationstakes asstarter.namestringRequireddescriptionstringRequiredWhat the starter is for, in a sentence.
definitionobjectRequiredWhat starts an automation and what it then does. Paths never join or loop: every step is reached from exactly one place, and a definition holds at most 50 steps.
triggerobjectRequiredWhat puts a contact into the automation. Null in a draft that has none yet, and a draft cannot be published without one.
Can be nullkindstringRequired- One of
"audience_joined" audienceIdstringRequired- Up to 64 characters
includeImportedbooleanRequired
entrystringRequiredThe
keyof the first step, or null while the draft has no steps.Can be nullPattern^[a-z][a-z0-9]{2,23}$stepsobject[]RequiredEvery step, in any order. Each has a unique
key, and names the step after it by key innext, or inyesandnofor a branch. Null ends the path there.Up to 50 itemskeystringRequired- Pattern
^[a-z][a-z0-9]{2,23}$ namestring- Up to 80 characters
kindstringRequired- One of
"send_email" nextstringRequired- Can be nullPattern
^[a-z][a-z0-9]{2,23}$ templateIdstringRequired- Up to 64 characters
templateVersionintegerRequired- Can be nullAt least 1
fromobjectRequiredemailstringRequired- Up to 320 characters
namestring- Up to 120 characters
replyTostringRequired- Can be nullUp to 320 characters
subjectstringRequired- Can be nullUp to 300 characters
propsRecord<string, object>Required
AutomationStarterListobject
objectstring- One of
"list"
AutomationStatsobject
objectstringRequired- One of
"automation_stats" automationIdstringRequiredsincestringRequiredWhere the window starts.
Formatdate-timeuntilstringRequiredWhere the window ends.
Formatdate-timetotalsobjectRequiredThe whole automation over the window.
enteredintegerContacts that entered.
At least 0activeintegerContacts in it now, whatever the window.
At least 0completedintegerContacts that reached the end of a path.
At least 0exitedintegerContacts that left early.
At least 0sentintegerEmails sent.
At least 0deliveredintegerEmails delivered.
At least 0openedintegerEmails opened. Many mail apps hide opens, so read it as a floor.
At least 0clickedintegerEmails with a click.
At least 0bouncedintegerEmails that bounced.
At least 0complainedintegerEmails marked as spam.
At least 0unsubscribedintegerContacts that unsubscribed from one of its emails.
At least 0
stepsobject[]RequiredThe same numbers for each step.
stepKeystringThe
keyof the step.kindstring- One of
"send_email""wait""branch""add_to_audience""remove_from_audience""update_field""webhook""exit" enteredintegerContacts that reached the step.
At least 0waitingintegerContacts sitting at the step now.
At least 0completedintegerContacts whose path ended at the step.
At least 0exitedintegerContacts that left early at the step.
At least 0sentintegerEmails the step sent.
At least 0skippedintegerTimes the step did nothing, such as an address that cannot receive mail.
At least 0failedintegerTimes the step failed for good.
At least 0yesintegerContacts a branch sent down yes.
At least 0nointegerContacts a branch sent down no.
At least 0deliveredintegerEmails of the step that were delivered.
At least 0openedintegerEmails of the step that were opened.
At least 0clickedintegerEmails of the step with a click.
At least 0bouncedintegerEmails of the step that bounced.
At least 0complainedintegerEmails of the step marked as spam.
At least 0unsubscribedintegerContacts that unsubscribed from an email of the step.
At least 0
seriesobject[]RequiredOne point for each UTC day in the window on which something happened, oldest first.
daystringThe start of the day, in UTC.
Formatdate-timeenteredintegerContacts that entered that day.
At least 0completedintegerContacts that completed that day.
At least 0exitedintegerContacts that left early that day.
At least 0sentintegerEmails sent that day.
At least 0
AutomationSummaryobject
objectstringRequired- One of
"automation" idstringRequiredThe id of the automation. It never changes.
namestringRequiredWhat the workspace calls it. Contacts never see it.
descriptionstringRequiredA note for the workspace.
Can be nullstatusstringRequireddraftuntil the first publish.livetakes contacts in and moves them along.pausedtakes nobody in and holds everyone where they are.archivedis retired for good and everyone in it has left.One of"draft""live""paused""archived"triggerKindstringRequiredWhat starts the draft, or null while it has no trigger.
Can be nullOne of"audience_joined""form_submitted""event""date""manual"stepCountintegerRequiredHow many steps the draft holds.
At least 0emailCountintegerRequiredHow many of those steps send an email.
At least 0hasUnpublishedChangesbooleanRequiredTrue when the draft differs from the version that is running.
publishedVersionintegerRequiredThe number of the version that is running. Null until the first publish.
Can be nullpausedReasonstringRequiredWhy it is paused.
manualis a person. The others are OpenEmail stopping it:sender_refusedwhen its from address can no longer send,key_revokedwhen the API key that published it was revoked, expired or turned off,template_unavailablewhen one of its templates can no longer be sent,audience_missingwhen an audience it depends on is gone, andplan_limitwhen the plan no longer covers this many live automations. Null while it is not paused.Can be nullOne of"manual""sender_refused""key_revoked""template_unavailable""audience_missing""plan_limit"lastErrorstringRequiredWhat went wrong the last time OpenEmail paused it, in a sentence. Null otherwise.
Can be nullcountsobjectRequiredContacts, counted at the moment of the read.
activeintegerRequiredIn the automation now.
At least 0completedintegerRequiredReached the end of a path, in all its time.
At least 0exitedintegerRequiredLeft before the end, in all its time.
At least 0
createdBystringRequiredThe user id of the person who made it. Null when that account is gone.
Can be nullpublishedAtstringRequiredThe last publish. Null until the first.
Can be nullFormatdate-timepausedAtstringRequiredWhen it was paused. Null while it is not.
Can be nullFormatdate-timearchivedAtstringRequiredWhen it was archived. Null otherwise.
Can be nullFormatdate-timecreatedAtstringRequiredWhen it was made.
Formatdate-timeupdatedAtstringRequiredThe last save. Send it back as
expectedUpdatedAtso a change never overwrites one you have not seen.Formatdate-time
AutomationTestobject
objectstringRequired- One of
"automation_test" automationIdstringRequiredemailIdstringRequiredThe test email, as
GET /emails/{id}returns it.tostringRequiredWhere it went.
FormatemailstepKeystringRequiredThe step that was sent.
AutomationVersionobject
objectstringRequired- One of
"automation_version" idstringRequiredautomationIdstringRequiredversionintegerRequiredCounts up from 1 with each publish that changed the definition.
At least 1definitionobjectRequiredWhat starts an automation and what it then does. Paths never join or loop: every step is reached from exactly one place, and a definition holds at most 50 steps.
triggerobjectRequiredWhat puts a contact into the automation. Null in a draft that has none yet, and a draft cannot be published without one.
Can be nullkindstringRequired- One of
"audience_joined" audienceIdstringRequired- Up to 64 characters
includeImportedbooleanRequired
entrystringRequiredThe
keyof the first step, or null while the draft has no steps.Can be nullPattern^[a-z][a-z0-9]{2,23}$stepsobject[]RequiredEvery step, in any order. Each has a unique
key, and names the step after it by key innext, or inyesandnofor a branch. Null ends the path there.Up to 50 itemskeystringRequired- Pattern
^[a-z][a-z0-9]{2,23}$ namestring- Up to 80 characters
kindstringRequired- One of
"send_email" nextstringRequired- Can be nullPattern
^[a-z][a-z0-9]{2,23}$ templateIdstringRequired- Up to 64 characters
templateVersionintegerRequired- Can be nullAt least 1
fromobjectRequiredemailstringRequired- Up to 320 characters
namestring- Up to 120 characters
replyTostringRequired- Can be nullUp to 320 characters
subjectstringRequired- Can be nullUp to 300 characters
propsRecord<string, object>Required
currentbooleanRequiredTrue for the version that is running.
createdBystringRequiredThe user id of whoever published it.
Can be nullcreatedAtstringRequiredWhen it was published.
Formatdate-time
AutomationVersionListobject
objectstring- One of
"list"
DeletedAutomationobject
objectstringRequired- One of
"automation" idstringRequireddeletedbooleanRequired- One of
true