Automatisierungen
Jede Operation in dieser Gruppe: was sie annimmt, was sie zurückgibt und mit welchen Fehlern sie antworten kann.
Operationen
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-Parameter
statusstringOnly automations in this state.
Einer von"draft""live""paused""archived"limitintegerRows per page, 1 to 100.
Mindestens 1Höchstens 100Standard50cursorstringThe 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.
Rückgabe
A page of automations.
Fehler
Die Fehler, die jede Operation zurückgeben kann400401403404422500Fehlerkatalog
Auch verfügbar über
- 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
namestringErforderlichWhat the workspace calls the automation, trimmed, 1 to 120 characters. Contacts never see it, and it need not be unique.
1 bis 120 ZeichendescriptionstringA note for the workspace, at most 500 characters. Contacts never see it.
Kann null seinBis zu 500 ZeichenstarterstringBegin 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 bis 64 ZeichendefinitionobjectWhat 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.
triggerobjectErforderlichWhat puts a contact into the automation. Null in a draft that has none yet, and a draft cannot be published without one.
Kann null seinkindstringErforderlich- Einer von
"audience_joined" audienceIdstringErforderlich- Bis zu 64 Zeichen
includeImportedbooleanErforderlich
entrystringErforderlichThe
keyof the first step, or null while the draft has no steps.Kann null seinMuster^[a-z][a-z0-9]{2,23}$stepsobject[]ErforderlichEvery 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.Bis zu 50 EinträgekeystringErforderlich- Muster
^[a-z][a-z0-9]{2,23}$ namestring- Bis zu 80 Zeichen
kindstringErforderlich- Einer von
"send_email" nextstringErforderlich- Kann null seinMuster
^[a-z][a-z0-9]{2,23}$ templateIdstringErforderlich- Bis zu 64 Zeichen
templateVersionintegerErforderlich- Kann null seinMindestens 1
fromobjectErforderlichemailstringErforderlich- Bis zu 320 Zeichen
namestring- Bis zu 120 Zeichen
replyTostringErforderlich- Kann null seinBis zu 320 Zeichen
subjectstringErforderlich- Kann null seinBis zu 300 Zeichen
propsRecord<string, object>Erforderlich
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 bis 64 Zeichen
sendWindowobject- Kann null sein
daysinteger[]Erforderlich- Bis zu 7 Einträge
startMinuteintegerErforderlich- Mindestens 0Höchstens 1440
endMinuteintegerErforderlich- Mindestens 0Höchstens 1440
reentryDaysinteger- Kann null seinMindestens 1Höchstens 3650
exitOnLeavebooleanlistAudienceIdstring- Kann null seinBis zu 64 Zeichen
Rückgabe
Created, as a draft.
Fehler
- 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.
Die Fehler, die jede Operation zurückgeben kann400401403404500Fehlerkatalog
Auch verfügbar über
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.
Rückgabe
Every starter.
Fehler
Die Fehler, die jede Operation zurückgeben kann400401403404422500Fehlerkatalog
Auch verfügbar über
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.
Pfadparameter
idstringErforderlichThe automation, such as
aut_5c1e9a7b3d2f48e6a0b4c7d1, asGET /automationslists it.
Rückgabe
The automation.
Fehler
- 404
automation_not_foundwhen the id names no automation you can reach.
Die Fehler, die jede Operation zurückgeben kann400401403422500Fehlerkatalog
Auch verfügbar über
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.
Pfadparameter
idstringErforderlichThe 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 bis 120 ZeichendescriptionstringA note for the workspace, at most 500 characters. Contacts never see it.
Kann null seinBis zu 500 ZeichendefinitionobjectWhat 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.
triggerobjectErforderlichWhat puts a contact into the automation. Null in a draft that has none yet, and a draft cannot be published without one.
Kann null seinkindstringErforderlich- Einer von
"audience_joined" audienceIdstringErforderlich- Bis zu 64 Zeichen
includeImportedbooleanErforderlich
entrystringErforderlichThe
keyof the first step, or null while the draft has no steps.Kann null seinMuster^[a-z][a-z0-9]{2,23}$stepsobject[]ErforderlichEvery 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.Bis zu 50 EinträgekeystringErforderlich- Muster
^[a-z][a-z0-9]{2,23}$ namestring- Bis zu 80 Zeichen
kindstringErforderlich- Einer von
"send_email" nextstringErforderlich- Kann null seinMuster
^[a-z][a-z0-9]{2,23}$ templateIdstringErforderlich- Bis zu 64 Zeichen
templateVersionintegerErforderlich- Kann null seinMindestens 1
fromobjectErforderlichemailstringErforderlich- Bis zu 320 Zeichen
namestring- Bis zu 120 Zeichen
replyTostringErforderlich- Kann null seinBis zu 320 Zeichen
subjectstringErforderlich- Kann null seinBis zu 300 Zeichen
propsRecord<string, object>Erforderlich
settingsobjectMerged field by field into the stored settings, and applied at once, without publishing. Send only the fields you are changing.
timezonestring- 1 bis 64 Zeichen
sendWindowobject- Kann null sein
daysinteger[]Erforderlich- Bis zu 7 Einträge
startMinuteintegerErforderlich- Mindestens 0Höchstens 1440
endMinuteintegerErforderlich- Mindestens 0Höchstens 1440
reentryDaysinteger- Kann null seinMindestens 1Höchstens 3650
exitOnLeavebooleanlistAudienceIdstring- Kann null seinBis zu 64 Zeichen
expectedUpdatedAtstringThe
updatedAtyou read. When the automation was saved since, the call is refused with 409version_conflictand nothing is written.Formatdate-time
Rückgabe
Saved.
Fehler
- 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.
Die Fehler, die jede Operation zurückgeben kann400401403500Fehlerkatalog
Auch verfügbar über
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.
Pfadparameter
idstringErforderlichThe automation, such as
aut_5c1e9a7b3d2f48e6a0b4c7d1, asGET /automationslists it.
Rückgabe
Deleted.
Fehler
- 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.
Die Fehler, die jede Operation zurückgeben kann400401422500Fehlerkatalog
Auch verfügbar über
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.
Pfadparameter
idstringErforderlichThe automation, such as
aut_5c1e9a7b3d2f48e6a0b4c7d1, asGET /automationslists it.
Rückgabe
Published and live.
Fehler
- 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.
Die Fehler, die jede Operation zurückgeben kann400401500Fehlerkatalog
Auch verfügbar über
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.
Pfadparameter
idstringErforderlichThe automation, such as
aut_5c1e9a7b3d2f48e6a0b4c7d1, asGET /automationslists it.
Rückgabe
Paused.
Fehler
- 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.
Die Fehler, die jede Operation zurückgeben kann400401403422500Fehlerkatalog
Auch verfügbar über
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.
Pfadparameter
idstringErforderlichThe automation, such as
aut_5c1e9a7b3d2f48e6a0b4c7d1, asGET /automationslists it.
Rückgabe
Live again.
Fehler
- 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.
Die Fehler, die jede Operation zurückgeben kann400401500Fehlerkatalog
Auch verfügbar über
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.
Pfadparameter
idstringErforderlichThe automation, such as
aut_5c1e9a7b3d2f48e6a0b4c7d1, asGET /automationslists it.
Rückgabe
Archived.
Fehler
- 404
automation_not_foundwhen the id names no automation you can reach.
Die Fehler, die jede Operation zurückgeben kann400401403422500Fehlerkatalog
Auch verfügbar über
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.
Pfadparameter
idstringErforderlichThe automation, such as
aut_5c1e9a7b3d2f48e6a0b4c7d1, asGET /automationslists it.
Rückgabe
The copy, as a draft.
Fehler
- 404
automation_not_foundwhen the id names no automation you can reach.- 422
workspace_limit_reachedwhen the workspace holds the most automations it may.
Die Fehler, die jede Operation zurückgeben kann400401403500Fehlerkatalog
Auch verfügbar über
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.
Pfadparameter
idstringErforderlichThe automation, such as
aut_5c1e9a7b3d2f48e6a0b4c7d1, asGET /automationslists it.
Request-Body
stepKeystringErforderlichThe
keyof the email step to send, from the draftdefinition.1 bis 64 ZeichentostringWhere the test goes. Left out, it goes to the account email of the person the key or app acts for.
Bis zu 320 ZeichenFormatemail
Rückgabe
Sent.
Fehler
- 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.
Die Fehler, die jede Operation zurückgeben kann400401500Fehlerkatalog
Auch verfügbar über
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.
Pfadparameter
idstringErforderlichThe automation, such as
aut_5c1e9a7b3d2f48e6a0b4c7d1, asGET /automationslists it.
Rückgabe
The versions.
Fehler
- 404
automation_not_foundwhen the id names no automation you can reach.
Die Fehler, die jede Operation zurückgeben kann400401403422500Fehlerkatalog
Auch verfügbar über
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.
Pfadparameter
idstringErforderlichThe automation, such as
aut_5c1e9a7b3d2f48e6a0b4c7d1, asGET /automationslists it.versionintegerErforderlichThe number of the version, as
GET /automations/{id}/versionslists it.Mindestens 1
Rückgabe
The automation, with the version in its draft.
Fehler
- 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.
Die Fehler, die jede Operation zurückgeben kann400401403422500Fehlerkatalog
Auch verfügbar über
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.
Pfadparameter
idstringErforderlichThe automation, such as
aut_5c1e9a7b3d2f48e6a0b4c7d1, asGET /automationslists it.
Query-Parameter
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
Rückgabe
The numbers for the window.
Fehler
- 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.
Die Fehler, die jede Operation zurückgeben kann400401403500Fehlerkatalog
Auch verfügbar über
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.
Pfadparameter
idstringErforderlichThe automation, such as
aut_5c1e9a7b3d2f48e6a0b4c7d1, asGET /automationslists it.
Query-Parameter
statusstringOnly enrollments in this state.
Einer von"active""completed""exited"stepKeystringOnly contacts at the step with this
key.1 bis 64 ZeichenqstringOnly contacts whose address or name contains this text, compared without case.
Bis zu 200 ZeichenlimitintegerRows per page, 1 to 200.
Mindestens 1Höchstens 200Standard50cursorstringThe 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.
Rückgabe
A page of enrollments.
Fehler
- 404
automation_not_foundwhen the id names no automation you can reach.
Die Fehler, die jede Operation zurückgeben kann400401403422500Fehlerkatalog
Auch verfügbar über
- 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.
Pfadparameter
idstringErforderlichThe automation, such as
aut_5c1e9a7b3d2f48e6a0b4c7d1, asGET /automationslists it.
Request-Body
contactIdstringThe contact, by id. Send this or
email, never both.1 bis 64 ZeichenemailstringThe contact, by email address. Send this or
contactId, never both.Bis zu 320 ZeichenFormatemaildataRecord<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.
Rückgabe
Enrolled, and due at the first step.
Fehler
- 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.
Die Fehler, die jede Operation zurückgeben kann400401403500Fehlerkatalog
Auch verfügbar über
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.
Pfadparameter
idstringErforderlichThe automation, such as
aut_5c1e9a7b3d2f48e6a0b4c7d1, asGET /automationslists it.enrollmentIdstringErforderlichThe enrollment, such as
aen_2b8d4f6a1c3e5079b6d8f0a2, asGET /automations/{id}/enrollmentslists it.
Rückgabe
The enrollment with its runs.
Fehler
Die Fehler, die jede Operation zurückgeben kann400401403422500Fehlerkatalog
Auch verfügbar über
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.
Pfadparameter
idstringErforderlichThe automation, such as
aut_5c1e9a7b3d2f48e6a0b4c7d1, asGET /automationslists it.enrollmentIdstringErforderlichThe enrollment, such as
aen_2b8d4f6a1c3e5079b6d8f0a2, asGET /automations/{id}/enrollmentslists it.
Rückgabe
The enrollment, exited.
Fehler
- 409
automation_enrollment_finished: the contact already completed or left.
Die Fehler, die jede Operation zurückgeben kann400401403422500Fehlerkatalog
Auch verfügbar über
Objekte
Automationobject
objectstringErforderlich- Einer von
"automation" idstringErforderlichThe id of the automation. It never changes.
namestringErforderlichWhat the workspace calls it. Contacts never see it.
descriptionstringErforderlichA note for the workspace.
Kann null seinstatusstringErforderlichdraftuntil 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.Einer von"draft""live""paused""archived"triggerKindstringErforderlichWhat starts the draft, or null while it has no trigger.
Kann null seinEiner von"audience_joined""form_submitted""event""date""manual"stepCountintegerErforderlichHow many steps the draft holds.
Mindestens 0emailCountintegerErforderlichHow many of those steps send an email.
Mindestens 0hasUnpublishedChangesbooleanErforderlichTrue when the draft differs from the version that is running.
publishedVersionintegerErforderlichThe number of the version that is running. Null until the first publish.
Kann null seinpausedReasonstringErforderlichWhy 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.Kann null seinEiner von"manual""sender_refused""key_revoked""template_unavailable""audience_missing""plan_limit"lastErrorstringErforderlichWhat went wrong the last time OpenEmail paused it, in a sentence. Null otherwise.
Kann null seincountsobjectErforderlichContacts, counted at the moment of the read.
activeintegerErforderlichIn the automation now.
Mindestens 0completedintegerErforderlichReached the end of a path, in all its time.
Mindestens 0exitedintegerErforderlichLeft before the end, in all its time.
Mindestens 0
createdBystringErforderlichThe user id of the person who made it. Null when that account is gone.
Kann null seinpublishedAtstringErforderlichThe last publish. Null until the first.
Kann null seinFormatdate-timepausedAtstringErforderlichWhen it was paused. Null while it is not.
Kann null seinFormatdate-timearchivedAtstringErforderlichWhen it was archived. Null otherwise.
Kann null seinFormatdate-timecreatedAtstringErforderlichWhen it was made.
Formatdate-timeupdatedAtstringErforderlichThe last save. Send it back as
expectedUpdatedAtso a change never overwrites one you have not seen.Formatdate-timedefinitionobjectErforderlichWhat 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.
triggerobjectErforderlichWhat puts a contact into the automation. Null in a draft that has none yet, and a draft cannot be published without one.
Kann null seinkindstringErforderlich- Einer von
"audience_joined" audienceIdstringErforderlich- Bis zu 64 Zeichen
includeImportedbooleanErforderlich
entrystringErforderlichThe
keyof the first step, or null while the draft has no steps.Kann null seinMuster^[a-z][a-z0-9]{2,23}$stepsobject[]ErforderlichEvery 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.Bis zu 50 EinträgekeystringErforderlich- Muster
^[a-z][a-z0-9]{2,23}$ namestring- Bis zu 80 Zeichen
kindstringErforderlich- Einer von
"send_email" nextstringErforderlich- Kann null seinMuster
^[a-z][a-z0-9]{2,23}$ templateIdstringErforderlich- Bis zu 64 Zeichen
templateVersionintegerErforderlich- Kann null seinMindestens 1
fromobjectErforderlichemailstringErforderlich- Bis zu 320 Zeichen
namestring- Bis zu 120 Zeichen
replyTostringErforderlich- Kann null seinBis zu 320 Zeichen
subjectstringErforderlich- Kann null seinBis zu 300 Zeichen
propsRecord<string, object>Erforderlich
publishedobjectErforderlichWhat 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.
Kann null seintriggerobjectErforderlichWhat puts a contact into the automation. Null in a draft that has none yet, and a draft cannot be published without one.
Kann null seinkindstringErforderlich- Einer von
"audience_joined" audienceIdstringErforderlich- Bis zu 64 Zeichen
includeImportedbooleanErforderlich
entrystringErforderlichThe
keyof the first step, or null while the draft has no steps.Kann null seinMuster^[a-z][a-z0-9]{2,23}$stepsobject[]ErforderlichEvery 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.Bis zu 50 EinträgekeystringErforderlich- Muster
^[a-z][a-z0-9]{2,23}$ namestring- Bis zu 80 Zeichen
kindstringErforderlich- Einer von
"send_email" nextstringErforderlich- Kann null seinMuster
^[a-z][a-z0-9]{2,23}$ templateIdstringErforderlich- Bis zu 64 Zeichen
templateVersionintegerErforderlich- Kann null seinMindestens 1
fromobjectErforderlichemailstringErforderlich- Bis zu 320 Zeichen
namestring- Bis zu 120 Zeichen
replyTostringErforderlich- Kann null seinBis zu 320 Zeichen
subjectstringErforderlich- Kann null seinBis zu 300 Zeichen
propsRecord<string, object>Erforderlich
settingsobjectErforderlichHow it runs. Settings take effect when they are saved, published or not.
timezonestringErforderlichThe 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 bis 64 ZeichensendWindowobjectErforderlichWhen 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.Kann null seindaysinteger[]Erforderlich- Bis zu 7 Einträge
startMinuteintegerErforderlich- Mindestens 0Höchstens 1440
endMinuteintegerErforderlich- Mindestens 0Höchstens 1440
reentryDaysintegerErforderlichHow many days after a contact finishes before they may enter again. Null lets each contact through once only.
Kann null seinMindestens 1Höchstens 3650exitOnLeavebooleanErforderlichTake a contact out when they leave the audience that started the automation. True by default.
listAudienceIdstringErforderlichThe 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.
Kann null seinBis zu 64 Zeichen
problemsAutomationProblem[]ErforderlichWhat 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
objectstringErforderlich- Einer von
"automation_enrollment" idstringErforderlichThe id of the enrollment.
automationIdstringErforderlichversionintegerErforderlichThe published version the contact entered on and stays on. Null when that version is gone.
Kann null seincontactobjectErforderlichidstringErforderlichThe id of the contact.
emailstringErforderlich- Format
email namestringErforderlich- Kann null sein
statusstringErforderlichactivewhile the contact is in it,completedat the end of a path,exitedwhen they left early.Einer von"active""completed""exited"sourcestringErforderlichHow they got in:
trigger, by hand in the app (manual), or through this API or an app (api).Einer von"trigger""manual""api"stepKeystringErforderlichThe
keyof the step the contact is at, or was at when they finished. Null before the first step.Kann null seinwaitingbooleanErforderlichTrue while the contact sits in a wait step.
waitingForEventstringErforderlichThe event name a wait step is holding out for. Null otherwise.
Kann null seinheldForstringErforderlichWhy 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.Kann null seinEiner von"window""quota""lane""retry"nextRunAtstringErforderlichWhen the contact moves next. Null once they finished.
Kann null seinFormatdate-timeexitReasonstringErforderlichHow 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.Kann null seinEiner von"completed""exit_step""unsubscribed""suppressed""left_audience""removed""archived""failed"lastErrorstringErforderlichThe last failure of a step, in a sentence.
Kann null seinstartedAtstringErforderlichWhen the contact entered.
Formatdate-timefinishedAtstringErforderlichWhen they completed or left. Null while active.
Kann null seinFormatdate-timeupdatedAtstringErforderlichThe last time anything about the enrollment changed.
Formatdate-time
AutomationEnrollmentDetailobject
objectstringErforderlich- Einer von
"automation_enrollment" idstringErforderlichThe id of the enrollment.
automationIdstringErforderlichversionintegerErforderlichThe published version the contact entered on and stays on. Null when that version is gone.
Kann null seincontactobjectErforderlichidstringErforderlichThe id of the contact.
emailstringErforderlich- Format
email namestringErforderlich- Kann null sein
statusstringErforderlichactivewhile the contact is in it,completedat the end of a path,exitedwhen they left early.Einer von"active""completed""exited"sourcestringErforderlichHow they got in:
trigger, by hand in the app (manual), or through this API or an app (api).Einer von"trigger""manual""api"stepKeystringErforderlichThe
keyof the step the contact is at, or was at when they finished. Null before the first step.Kann null seinwaitingbooleanErforderlichTrue while the contact sits in a wait step.
waitingForEventstringErforderlichThe event name a wait step is holding out for. Null otherwise.
Kann null seinheldForstringErforderlichWhy 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.Kann null seinEiner von"window""quota""lane""retry"nextRunAtstringErforderlichWhen the contact moves next. Null once they finished.
Kann null seinFormatdate-timeexitReasonstringErforderlichHow 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.Kann null seinEiner von"completed""exit_step""unsubscribed""suppressed""left_audience""removed""archived""failed"lastErrorstringErforderlichThe last failure of a step, in a sentence.
Kann null seinstartedAtstringErforderlichWhen the contact entered.
Formatdate-timefinishedAtstringErforderlichWhen they completed or left. Null while active.
Kann null seinFormatdate-timeupdatedAtstringErforderlichThe last time anything about the enrollment changed.
Formatdate-timerunsobject[]ErforderlichWhat each step did for the contact, oldest first.
idstringErforderlichstepKeystringErforderlichThe
keyof the step that ran.kindstringErforderlich- Einer von
"send_email""wait""branch""add_to_audience""remove_from_audience""update_field""webhook""exit" outcomestringErforderlichWhat happened: an email
sent, a waitwaitedout, a branch answeredyesorno, the contactaddedto orremovedfrom an audience, a fieldupdated, a webhookcalled, the pathexited, the stepskipped, or itfailed.Einer von"sent""skipped""waited""yes""no""added""removed""updated""called""exited""failed"emailIdstringErforderlichThe email a send step sent, as
GET /emailslists it. Null for every other step.Kann null seindetailstringErforderlichWhy a step was skipped or failed, or how a wait ended.
Kann null seincreatedAtstringErforderlichWhen the step ran.
Formatdate-time
AutomationEnrollmentListobject
objectstring- Einer von
"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.
Kann null seinautomationIdstringThe automation the enrollments belong to.
AutomationListobject
objectstring- Einer von
"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.
Kann null sein
AutomationProblemobject
codestringErforderlichWhat is wrong, for a program to branch on.
Einer von"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"pathstringErforderlichThe field at fault, dotted, such as
definition.steps.2.templateIdorsettings.timezone.stepKeystringErforderlichThe
keyof the step at fault. Null when it is the trigger or a setting.Kann null seinmessagestringErforderlichThe problem in a sentence a person can act on.
blockingbooleanErforderlichTrue when it stops a publish. False for a warning, such as a branch on opens.
AutomationStarterobject
objectstringErforderlich- Einer von
"automation_starter" slugstringErforderlichWhat
POST /automationstakes asstarter.namestringErforderlichdescriptionstringErforderlichWhat the starter is for, in a sentence.
definitionobjectErforderlichWhat 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.
triggerobjectErforderlichWhat puts a contact into the automation. Null in a draft that has none yet, and a draft cannot be published without one.
Kann null seinkindstringErforderlich- Einer von
"audience_joined" audienceIdstringErforderlich- Bis zu 64 Zeichen
includeImportedbooleanErforderlich
entrystringErforderlichThe
keyof the first step, or null while the draft has no steps.Kann null seinMuster^[a-z][a-z0-9]{2,23}$stepsobject[]ErforderlichEvery 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.Bis zu 50 EinträgekeystringErforderlich- Muster
^[a-z][a-z0-9]{2,23}$ namestring- Bis zu 80 Zeichen
kindstringErforderlich- Einer von
"send_email" nextstringErforderlich- Kann null seinMuster
^[a-z][a-z0-9]{2,23}$ templateIdstringErforderlich- Bis zu 64 Zeichen
templateVersionintegerErforderlich- Kann null seinMindestens 1
fromobjectErforderlichemailstringErforderlich- Bis zu 320 Zeichen
namestring- Bis zu 120 Zeichen
replyTostringErforderlich- Kann null seinBis zu 320 Zeichen
subjectstringErforderlich- Kann null seinBis zu 300 Zeichen
propsRecord<string, object>Erforderlich
AutomationStarterListobject
objectstring- Einer von
"list"
AutomationStatsobject
objectstringErforderlich- Einer von
"automation_stats" automationIdstringErforderlichsincestringErforderlichWhere the window starts.
Formatdate-timeuntilstringErforderlichWhere the window ends.
Formatdate-timetotalsobjectErforderlichThe whole automation over the window.
enteredintegerContacts that entered.
Mindestens 0activeintegerContacts in it now, whatever the window.
Mindestens 0completedintegerContacts that reached the end of a path.
Mindestens 0exitedintegerContacts that left early.
Mindestens 0sentintegerEmails sent.
Mindestens 0deliveredintegerEmails delivered.
Mindestens 0openedintegerEmails opened. Many mail apps hide opens, so read it as a floor.
Mindestens 0clickedintegerEmails with a click.
Mindestens 0bouncedintegerEmails that bounced.
Mindestens 0complainedintegerEmails marked as spam.
Mindestens 0unsubscribedintegerContacts that unsubscribed from one of its emails.
Mindestens 0
stepsobject[]ErforderlichThe same numbers for each step.
stepKeystringThe
keyof the step.kindstring- Einer von
"send_email""wait""branch""add_to_audience""remove_from_audience""update_field""webhook""exit" enteredintegerContacts that reached the step.
Mindestens 0waitingintegerContacts sitting at the step now.
Mindestens 0completedintegerContacts whose path ended at the step.
Mindestens 0exitedintegerContacts that left early at the step.
Mindestens 0sentintegerEmails the step sent.
Mindestens 0skippedintegerTimes the step did nothing, such as an address that cannot receive mail.
Mindestens 0failedintegerTimes the step failed for good.
Mindestens 0yesintegerContacts a branch sent down yes.
Mindestens 0nointegerContacts a branch sent down no.
Mindestens 0deliveredintegerEmails of the step that were delivered.
Mindestens 0openedintegerEmails of the step that were opened.
Mindestens 0clickedintegerEmails of the step with a click.
Mindestens 0bouncedintegerEmails of the step that bounced.
Mindestens 0complainedintegerEmails of the step marked as spam.
Mindestens 0unsubscribedintegerContacts that unsubscribed from an email of the step.
Mindestens 0
seriesobject[]ErforderlichOne 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.
Mindestens 0completedintegerContacts that completed that day.
Mindestens 0exitedintegerContacts that left early that day.
Mindestens 0sentintegerEmails sent that day.
Mindestens 0
AutomationSummaryobject
objectstringErforderlich- Einer von
"automation" idstringErforderlichThe id of the automation. It never changes.
namestringErforderlichWhat the workspace calls it. Contacts never see it.
descriptionstringErforderlichA note for the workspace.
Kann null seinstatusstringErforderlichdraftuntil 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.Einer von"draft""live""paused""archived"triggerKindstringErforderlichWhat starts the draft, or null while it has no trigger.
Kann null seinEiner von"audience_joined""form_submitted""event""date""manual"stepCountintegerErforderlichHow many steps the draft holds.
Mindestens 0emailCountintegerErforderlichHow many of those steps send an email.
Mindestens 0hasUnpublishedChangesbooleanErforderlichTrue when the draft differs from the version that is running.
publishedVersionintegerErforderlichThe number of the version that is running. Null until the first publish.
Kann null seinpausedReasonstringErforderlichWhy 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.Kann null seinEiner von"manual""sender_refused""key_revoked""template_unavailable""audience_missing""plan_limit"lastErrorstringErforderlichWhat went wrong the last time OpenEmail paused it, in a sentence. Null otherwise.
Kann null seincountsobjectErforderlichContacts, counted at the moment of the read.
activeintegerErforderlichIn the automation now.
Mindestens 0completedintegerErforderlichReached the end of a path, in all its time.
Mindestens 0exitedintegerErforderlichLeft before the end, in all its time.
Mindestens 0
createdBystringErforderlichThe user id of the person who made it. Null when that account is gone.
Kann null seinpublishedAtstringErforderlichThe last publish. Null until the first.
Kann null seinFormatdate-timepausedAtstringErforderlichWhen it was paused. Null while it is not.
Kann null seinFormatdate-timearchivedAtstringErforderlichWhen it was archived. Null otherwise.
Kann null seinFormatdate-timecreatedAtstringErforderlichWhen it was made.
Formatdate-timeupdatedAtstringErforderlichThe last save. Send it back as
expectedUpdatedAtso a change never overwrites one you have not seen.Formatdate-time
AutomationTestobject
objectstringErforderlich- Einer von
"automation_test" automationIdstringErforderlichemailIdstringErforderlichThe test email, as
GET /emails/{id}returns it.tostringErforderlichWhere it went.
FormatemailstepKeystringErforderlichThe step that was sent.
AutomationVersionobject
objectstringErforderlich- Einer von
"automation_version" idstringErforderlichautomationIdstringErforderlichversionintegerErforderlichCounts up from 1 with each publish that changed the definition.
Mindestens 1definitionobjectErforderlichWhat 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.
triggerobjectErforderlichWhat puts a contact into the automation. Null in a draft that has none yet, and a draft cannot be published without one.
Kann null seinkindstringErforderlich- Einer von
"audience_joined" audienceIdstringErforderlich- Bis zu 64 Zeichen
includeImportedbooleanErforderlich
entrystringErforderlichThe
keyof the first step, or null while the draft has no steps.Kann null seinMuster^[a-z][a-z0-9]{2,23}$stepsobject[]ErforderlichEvery 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.Bis zu 50 EinträgekeystringErforderlich- Muster
^[a-z][a-z0-9]{2,23}$ namestring- Bis zu 80 Zeichen
kindstringErforderlich- Einer von
"send_email" nextstringErforderlich- Kann null seinMuster
^[a-z][a-z0-9]{2,23}$ templateIdstringErforderlich- Bis zu 64 Zeichen
templateVersionintegerErforderlich- Kann null seinMindestens 1
fromobjectErforderlichemailstringErforderlich- Bis zu 320 Zeichen
namestring- Bis zu 120 Zeichen
replyTostringErforderlich- Kann null seinBis zu 320 Zeichen
subjectstringErforderlich- Kann null seinBis zu 300 Zeichen
propsRecord<string, object>Erforderlich
currentbooleanErforderlichTrue for the version that is running.
createdBystringErforderlichThe user id of whoever published it.
Kann null seincreatedAtstringErforderlichWhen it was published.
Formatdate-time
AutomationVersionListobject
objectstring- Einer von
"list"
DeletedAutomationobject
objectstringErforderlich- Einer von
"automation" idstringErforderlichdeletedbooleanErforderlich- Einer von
true