Автоматизации
Каждая операция этой группы: что она принимает, что возвращает и какими ошибками может ответить.
Операции
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.
Параметры запроса
statusstringOnly automations in this state.
Одно из"draft""live""paused""archived"limitintegerRows per page, 1 to 100.
Не меньше 1Не больше 100По умолчанию50cursorstringThe 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.
Возвращает
A page of automations.
Ошибки
Ошибки, которые может вернуть любая операция400401403404422500Каталог ошибок
Также доступно в
- 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.
Тело запроса
namestringОбязательноWhat the workspace calls the automation, trimmed, 1 to 120 characters. Contacts never see it, and it need not be unique.
От 1 до 120 символовdescriptionstringA note for the workspace, at most 500 characters. Contacts never see it.
Может быть nullДо 500 символовstarterstringBegin 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 до 64 символовdefinitionobjectWhat 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.
triggerobjectОбязательноWhat puts a contact into the automation. Null in a draft that has none yet, and a draft cannot be published without one.
Может быть nullkindstringОбязательно- Одно из
"audience_joined" audienceIdstringОбязательно- До 64 символов
includeImportedbooleanОбязательно
entrystringОбязательноThe
keyof the first step, or null while the draft has no steps.Может быть nullШаблон^[a-z][a-z0-9]{2,23}$stepsobject[]ОбязательноEvery 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.До 50 элементовkeystringОбязательно- Шаблон
^[a-z][a-z0-9]{2,23}$ namestring- До 80 символов
kindstringОбязательно- Одно из
"send_email" nextstringОбязательно- Может быть nullШаблон
^[a-z][a-z0-9]{2,23}$ templateIdstringОбязательно- До 64 символов
templateVersionintegerОбязательно- Может быть nullНе меньше 1
fromobjectОбязательноemailstringОбязательно- До 320 символов
namestring- До 120 символов
replyTostringОбязательно- Может быть nullДо 320 символов
subjectstringОбязательно- Может быть nullДо 300 символов
propsRecord<string, object>Обязательно
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 до 64 символов
sendWindowobject- Может быть null
daysinteger[]Обязательно- До 7 элементов
startMinuteintegerОбязательно- Не меньше 0Не больше 1440
endMinuteintegerОбязательно- Не меньше 0Не больше 1440
reentryDaysinteger- Может быть nullНе меньше 1Не больше 3650
exitOnLeavebooleanlistAudienceIdstring- Может быть nullДо 64 символов
Возвращает
Created, as a draft.
Ошибки
- 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.
Ошибки, которые может вернуть любая операция400401403404500Каталог ошибок
Также доступно в
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.
Возвращает
Every starter.
Ошибки
Ошибки, которые может вернуть любая операция400401403404422500Каталог ошибок
Также доступно в
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.
Параметры пути
idstringОбязательноThe automation, such as
aut_5c1e9a7b3d2f48e6a0b4c7d1, asGET /automationslists it.
Возвращает
The automation.
Ошибки
- 404
automation_not_foundwhen the id names no automation you can reach.
Ошибки, которые может вернуть любая операция400401403422500Каталог ошибок
Также доступно в
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.
Параметры пути
idstringОбязательноThe automation, such as
aut_5c1e9a7b3d2f48e6a0b4c7d1, asGET /automationslists it.
Тело запроса
namestringWhat the workspace calls the automation, trimmed, 1 to 120 characters. Contacts never see it, and it need not be unique.
От 1 до 120 символовdescriptionstringA note for the workspace, at most 500 characters. Contacts never see it.
Может быть nullДо 500 символовdefinitionobjectWhat 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.
triggerobjectОбязательноWhat puts a contact into the automation. Null in a draft that has none yet, and a draft cannot be published without one.
Может быть nullkindstringОбязательно- Одно из
"audience_joined" audienceIdstringОбязательно- До 64 символов
includeImportedbooleanОбязательно
entrystringОбязательноThe
keyof the first step, or null while the draft has no steps.Может быть nullШаблон^[a-z][a-z0-9]{2,23}$stepsobject[]ОбязательноEvery 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.До 50 элементовkeystringОбязательно- Шаблон
^[a-z][a-z0-9]{2,23}$ namestring- До 80 символов
kindstringОбязательно- Одно из
"send_email" nextstringОбязательно- Может быть nullШаблон
^[a-z][a-z0-9]{2,23}$ templateIdstringОбязательно- До 64 символов
templateVersionintegerОбязательно- Может быть nullНе меньше 1
fromobjectОбязательноemailstringОбязательно- До 320 символов
namestring- До 120 символов
replyTostringОбязательно- Может быть nullДо 320 символов
subjectstringОбязательно- Может быть nullДо 300 символов
propsRecord<string, object>Обязательно
settingsobjectMerged field by field into the stored settings, and applied at once, without publishing. Send only the fields you are changing.
timezonestring- От 1 до 64 символов
sendWindowobject- Может быть null
daysinteger[]Обязательно- До 7 элементов
startMinuteintegerОбязательно- Не меньше 0Не больше 1440
endMinuteintegerОбязательно- Не меньше 0Не больше 1440
reentryDaysinteger- Может быть nullНе меньше 1Не больше 3650
exitOnLeavebooleanlistAudienceIdstring- Может быть nullДо 64 символов
expectedUpdatedAtstringThe
updatedAtyou read. When the automation was saved since, the call is refused with 409version_conflictand nothing is written.Форматdate-time
Возвращает
Saved.
Ошибки
- 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.
Ошибки, которые может вернуть любая операция400401403500Каталог ошибок
Также доступно в
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.
Параметры пути
idstringОбязательноThe automation, such as
aut_5c1e9a7b3d2f48e6a0b4c7d1, asGET /automationslists it.
Возвращает
Deleted.
Ошибки
- 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.
Ошибки, которые может вернуть любая операция400401422500Каталог ошибок
Также доступно в
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.
Параметры пути
idstringОбязательноThe automation, such as
aut_5c1e9a7b3d2f48e6a0b4c7d1, asGET /automationslists it.
Возвращает
Published and live.
Ошибки
- 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.
Ошибки, которые может вернуть любая операция400401500Каталог ошибок
Также доступно в
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.
Параметры пути
idstringОбязательноThe automation, such as
aut_5c1e9a7b3d2f48e6a0b4c7d1, asGET /automationslists it.
Возвращает
Paused.
Ошибки
- 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.
Ошибки, которые может вернуть любая операция400401403422500Каталог ошибок
Также доступно в
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.
Параметры пути
idstringОбязательноThe automation, such as
aut_5c1e9a7b3d2f48e6a0b4c7d1, asGET /automationslists it.
Возвращает
Live again.
Ошибки
- 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.
Ошибки, которые может вернуть любая операция400401500Каталог ошибок
Также доступно в
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.
Параметры пути
idstringОбязательноThe automation, such as
aut_5c1e9a7b3d2f48e6a0b4c7d1, asGET /automationslists it.
Возвращает
Archived.
Ошибки
- 404
automation_not_foundwhen the id names no automation you can reach.
Ошибки, которые может вернуть любая операция400401403422500Каталог ошибок
Также доступно в
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.
Параметры пути
idstringОбязательноThe automation, such as
aut_5c1e9a7b3d2f48e6a0b4c7d1, asGET /automationslists it.
Возвращает
The copy, as a draft.
Ошибки
- 404
automation_not_foundwhen the id names no automation you can reach.- 422
workspace_limit_reachedwhen the workspace holds the most automations it may.
Ошибки, которые может вернуть любая операция400401403500Каталог ошибок
Также доступно в
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.
Параметры пути
idstringОбязательноThe automation, such as
aut_5c1e9a7b3d2f48e6a0b4c7d1, asGET /automationslists it.
Тело запроса
stepKeystringОбязательноThe
keyof the email step to send, from the draftdefinition.От 1 до 64 символовtostringWhere the test goes. Left out, it goes to the account email of the person the key or app acts for.
До 320 символовФорматemail
Возвращает
Sent.
Ошибки
- 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.
Ошибки, которые может вернуть любая операция400401500Каталог ошибок
Также доступно в
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.
Параметры пути
idstringОбязательноThe automation, such as
aut_5c1e9a7b3d2f48e6a0b4c7d1, asGET /automationslists it.
Возвращает
The versions.
Ошибки
- 404
automation_not_foundwhen the id names no automation you can reach.
Ошибки, которые может вернуть любая операция400401403422500Каталог ошибок
Также доступно в
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.
Параметры пути
idstringОбязательноThe automation, such as
aut_5c1e9a7b3d2f48e6a0b4c7d1, asGET /automationslists it.versionintegerОбязательноThe number of the version, as
GET /automations/{id}/versionslists it.Не меньше 1
Возвращает
The automation, with the version in its draft.
Ошибки
- 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.
Ошибки, которые может вернуть любая операция400401403422500Каталог ошибок
Также доступно в
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.
Параметры пути
idstringОбязательноThe automation, such as
aut_5c1e9a7b3d2f48e6a0b4c7d1, asGET /automationslists it.
Параметры запроса
sincestringWhere the window starts, as an ISO 8601 instant. Left out, 30 days before
until. It reaches back at most 366 days beforeuntil.Форматdate-timeuntilstringWhere the window ends, as an ISO 8601 instant. Left out, now.
Форматdate-time
Возвращает
The numbers for the window.
Ошибки
- 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.
Ошибки, которые может вернуть любая операция400401403500Каталог ошибок
Также доступно в
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.
Параметры пути
idstringОбязательноThe automation, such as
aut_5c1e9a7b3d2f48e6a0b4c7d1, asGET /automationslists it.
Параметры запроса
statusstringOnly enrollments in this state.
Одно из"active""completed""exited"stepKeystringOnly contacts at the step with this
key.От 1 до 64 символовqstringOnly contacts whose address or name contains this text, compared without case.
До 200 символовlimitintegerRows per page, 1 to 200.
Не меньше 1Не больше 200По умолчанию50cursorstringThe 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.
Возвращает
A page of enrollments.
Ошибки
- 404
automation_not_foundwhen the id names no automation you can reach.
Ошибки, которые может вернуть любая операция400401403422500Каталог ошибок
Также доступно в
- 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.
Параметры пути
idstringОбязательноThe automation, such as
aut_5c1e9a7b3d2f48e6a0b4c7d1, asGET /automationslists it.
Тело запроса
contactIdstringThe contact, by id. Send this or
email, never both.От 1 до 64 символовemailstringThe contact, by email address. Send this or
contactId, never both.До 320 символовФорматemaildataRecord<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.
Возвращает
Enrolled, and due at the first step.
Ошибки
- 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.
Ошибки, которые может вернуть любая операция400401403500Каталог ошибок
Также доступно в
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.
Параметры пути
idstringОбязательноThe automation, such as
aut_5c1e9a7b3d2f48e6a0b4c7d1, asGET /automationslists it.enrollmentIdstringОбязательноThe enrollment, such as
aen_2b8d4f6a1c3e5079b6d8f0a2, asGET /automations/{id}/enrollmentslists it.
Возвращает
The enrollment with its runs.
Ошибки
Ошибки, которые может вернуть любая операция400401403422500Каталог ошибок
Также доступно в
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.
Параметры пути
idstringОбязательноThe automation, such as
aut_5c1e9a7b3d2f48e6a0b4c7d1, asGET /automationslists it.enrollmentIdstringОбязательноThe enrollment, such as
aen_2b8d4f6a1c3e5079b6d8f0a2, asGET /automations/{id}/enrollmentslists it.
Возвращает
The enrollment, exited.
Ошибки
- 409
automation_enrollment_finished: the contact already completed or left.
Ошибки, которые может вернуть любая операция400401403422500Каталог ошибок
Также доступно в
Объекты
Automationobject
objectstringОбязательно- Одно из
"automation" idstringОбязательноThe id of the automation. It never changes.
namestringОбязательноWhat the workspace calls it. Contacts never see it.
descriptionstringОбязательноA note for the workspace.
Может быть nullstatusstringОбязательноdraftuntil 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.Одно из"draft""live""paused""archived"triggerKindstringОбязательноWhat starts the draft, or null while it has no trigger.
Может быть nullОдно из"audience_joined""form_submitted""event""date""manual"stepCountintegerОбязательноHow many steps the draft holds.
Не меньше 0emailCountintegerОбязательноHow many of those steps send an email.
Не меньше 0hasUnpublishedChangesbooleanОбязательноTrue when the draft differs from the version that is running.
publishedVersionintegerОбязательноThe number of the version that is running. Null until the first publish.
Может быть nullpausedReasonstringОбязательноWhy 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.Может быть nullОдно из"manual""sender_refused""key_revoked""template_unavailable""audience_missing""plan_limit"lastErrorstringОбязательноWhat went wrong the last time OpenEmail paused it, in a sentence. Null otherwise.
Может быть nullcountsobjectОбязательноContacts, counted at the moment of the read.
activeintegerОбязательноIn the automation now.
Не меньше 0completedintegerОбязательноReached the end of a path, in all its time.
Не меньше 0exitedintegerОбязательноLeft before the end, in all its time.
Не меньше 0
createdBystringОбязательноThe user id of the person who made it. Null when that account is gone.
Может быть nullpublishedAtstringОбязательноThe last publish. Null until the first.
Может быть nullФорматdate-timepausedAtstringОбязательноWhen it was paused. Null while it is not.
Может быть nullФорматdate-timearchivedAtstringОбязательноWhen it was archived. Null otherwise.
Может быть nullФорматdate-timecreatedAtstringОбязательноWhen it was made.
Форматdate-timeupdatedAtstringОбязательноThe last save. Send it back as
expectedUpdatedAtso a change never overwrites one you have not seen.Форматdate-timedefinitionobjectОбязательноWhat 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.
triggerobjectОбязательноWhat puts a contact into the automation. Null in a draft that has none yet, and a draft cannot be published without one.
Может быть nullkindstringОбязательно- Одно из
"audience_joined" audienceIdstringОбязательно- До 64 символов
includeImportedbooleanОбязательно
entrystringОбязательноThe
keyof the first step, or null while the draft has no steps.Может быть nullШаблон^[a-z][a-z0-9]{2,23}$stepsobject[]ОбязательноEvery 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.До 50 элементовkeystringОбязательно- Шаблон
^[a-z][a-z0-9]{2,23}$ namestring- До 80 символов
kindstringОбязательно- Одно из
"send_email" nextstringОбязательно- Может быть nullШаблон
^[a-z][a-z0-9]{2,23}$ templateIdstringОбязательно- До 64 символов
templateVersionintegerОбязательно- Может быть nullНе меньше 1
fromobjectОбязательноemailstringОбязательно- До 320 символов
namestring- До 120 символов
replyTostringОбязательно- Может быть nullДо 320 символов
subjectstringОбязательно- Может быть nullДо 300 символов
propsRecord<string, object>Обязательно
publishedobjectОбязательноWhat 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.
Может быть nulltriggerobjectОбязательноWhat puts a contact into the automation. Null in a draft that has none yet, and a draft cannot be published without one.
Может быть nullkindstringОбязательно- Одно из
"audience_joined" audienceIdstringОбязательно- До 64 символов
includeImportedbooleanОбязательно
entrystringОбязательноThe
keyof the first step, or null while the draft has no steps.Может быть nullШаблон^[a-z][a-z0-9]{2,23}$stepsobject[]ОбязательноEvery 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.До 50 элементовkeystringОбязательно- Шаблон
^[a-z][a-z0-9]{2,23}$ namestring- До 80 символов
kindstringОбязательно- Одно из
"send_email" nextstringОбязательно- Может быть nullШаблон
^[a-z][a-z0-9]{2,23}$ templateIdstringОбязательно- До 64 символов
templateVersionintegerОбязательно- Может быть nullНе меньше 1
fromobjectОбязательноemailstringОбязательно- До 320 символов
namestring- До 120 символов
replyTostringОбязательно- Может быть nullДо 320 символов
subjectstringОбязательно- Может быть nullДо 300 символов
propsRecord<string, object>Обязательно
settingsobjectОбязательноHow it runs. Settings take effect when they are saved, published or not.
timezonestringОбязательноThe 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 до 64 символовsendWindowobjectОбязательноWhen 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.Может быть nulldaysinteger[]Обязательно- До 7 элементов
startMinuteintegerОбязательно- Не меньше 0Не больше 1440
endMinuteintegerОбязательно- Не меньше 0Не больше 1440
reentryDaysintegerОбязательноHow many days after a contact finishes before they may enter again. Null lets each contact through once only.
Может быть nullНе меньше 1Не больше 3650exitOnLeavebooleanОбязательноTake a contact out when they leave the audience that started the automation. True by default.
listAudienceIdstringОбязательноThe 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.
Может быть nullДо 64 символов
problemsAutomationProblem[]ОбязательноWhat 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
objectstringОбязательно- Одно из
"automation_enrollment" idstringОбязательноThe id of the enrollment.
automationIdstringОбязательноversionintegerОбязательноThe published version the contact entered on and stays on. Null when that version is gone.
Может быть nullcontactobjectОбязательноidstringОбязательноThe id of the contact.
emailstringОбязательно- Формат
email namestringОбязательно- Может быть null
statusstringОбязательноactivewhile the contact is in it,completedat the end of a path,exitedwhen they left early.Одно из"active""completed""exited"sourcestringОбязательноHow they got in:
trigger, by hand in the app (manual), or through this API or an app (api).Одно из"trigger""manual""api"stepKeystringОбязательноThe
keyof the step the contact is at, or was at when they finished. Null before the first step.Может быть nullwaitingbooleanОбязательноTrue while the contact sits in a wait step.
waitingForEventstringОбязательноThe event name a wait step is holding out for. Null otherwise.
Может быть nullheldForstringОбязательноWhy 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.Может быть nullОдно из"window""quota""lane""retry"nextRunAtstringОбязательноWhen the contact moves next. Null once they finished.
Может быть nullФорматdate-timeexitReasonstringОбязательноHow 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.Может быть nullОдно из"completed""exit_step""unsubscribed""suppressed""left_audience""removed""archived""failed"lastErrorstringОбязательноThe last failure of a step, in a sentence.
Может быть nullstartedAtstringОбязательноWhen the contact entered.
Форматdate-timefinishedAtstringОбязательноWhen they completed or left. Null while active.
Может быть nullФорматdate-timeupdatedAtstringОбязательноThe last time anything about the enrollment changed.
Форматdate-time
AutomationEnrollmentDetailobject
objectstringОбязательно- Одно из
"automation_enrollment" idstringОбязательноThe id of the enrollment.
automationIdstringОбязательноversionintegerОбязательноThe published version the contact entered on and stays on. Null when that version is gone.
Может быть nullcontactobjectОбязательноidstringОбязательноThe id of the contact.
emailstringОбязательно- Формат
email namestringОбязательно- Может быть null
statusstringОбязательноactivewhile the contact is in it,completedat the end of a path,exitedwhen they left early.Одно из"active""completed""exited"sourcestringОбязательноHow they got in:
trigger, by hand in the app (manual), or through this API or an app (api).Одно из"trigger""manual""api"stepKeystringОбязательноThe
keyof the step the contact is at, or was at when they finished. Null before the first step.Может быть nullwaitingbooleanОбязательноTrue while the contact sits in a wait step.
waitingForEventstringОбязательноThe event name a wait step is holding out for. Null otherwise.
Может быть nullheldForstringОбязательноWhy 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.Может быть nullОдно из"window""quota""lane""retry"nextRunAtstringОбязательноWhen the contact moves next. Null once they finished.
Может быть nullФорматdate-timeexitReasonstringОбязательноHow 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.Может быть nullОдно из"completed""exit_step""unsubscribed""suppressed""left_audience""removed""archived""failed"lastErrorstringОбязательноThe last failure of a step, in a sentence.
Может быть nullstartedAtstringОбязательноWhen the contact entered.
Форматdate-timefinishedAtstringОбязательноWhen they completed or left. Null while active.
Может быть nullФорматdate-timeupdatedAtstringОбязательноThe last time anything about the enrollment changed.
Форматdate-timerunsobject[]ОбязательноWhat each step did for the contact, oldest first.
idstringОбязательноstepKeystringОбязательноThe
keyof the step that ran.kindstringОбязательно- Одно из
"send_email""wait""branch""add_to_audience""remove_from_audience""update_field""webhook""exit" outcomestringОбязательноWhat happened: an email
sent, a waitwaitedout, a branch answeredyesorno, the contactaddedto orremovedfrom an audience, a fieldupdated, a webhookcalled, the pathexited, the stepskipped, or itfailed.Одно из"sent""skipped""waited""yes""no""added""removed""updated""called""exited""failed"emailIdstringОбязательноThe email a send step sent, as
GET /emailslists it. Null for every other step.Может быть nulldetailstringОбязательноWhy a step was skipped or failed, or how a wait ended.
Может быть nullcreatedAtstringОбязательноWhen the step ran.
Форматdate-time
AutomationEnrollmentListobject
objectstring- Одно из
"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.
Может быть nullautomationIdstringThe automation the enrollments belong to.
AutomationListobject
objectstring- Одно из
"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.
Может быть null
AutomationProblemobject
codestringОбязательноWhat is wrong, for a program to branch on.
Одно из"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"pathstringОбязательноThe field at fault, dotted, such as
definition.steps.2.templateIdorsettings.timezone.stepKeystringОбязательноThe
keyof the step at fault. Null when it is the trigger or a setting.Может быть nullmessagestringОбязательноThe problem in a sentence a person can act on.
blockingbooleanОбязательноTrue when it stops a publish. False for a warning, such as a branch on opens.
AutomationStarterobject
objectstringОбязательно- Одно из
"automation_starter" slugstringОбязательноWhat
POST /automationstakes asstarter.namestringОбязательноdescriptionstringОбязательноWhat the starter is for, in a sentence.
definitionobjectОбязательноWhat 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.
triggerobjectОбязательноWhat puts a contact into the automation. Null in a draft that has none yet, and a draft cannot be published without one.
Может быть nullkindstringОбязательно- Одно из
"audience_joined" audienceIdstringОбязательно- До 64 символов
includeImportedbooleanОбязательно
entrystringОбязательноThe
keyof the first step, or null while the draft has no steps.Может быть nullШаблон^[a-z][a-z0-9]{2,23}$stepsobject[]ОбязательноEvery 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.До 50 элементовkeystringОбязательно- Шаблон
^[a-z][a-z0-9]{2,23}$ namestring- До 80 символов
kindstringОбязательно- Одно из
"send_email" nextstringОбязательно- Может быть nullШаблон
^[a-z][a-z0-9]{2,23}$ templateIdstringОбязательно- До 64 символов
templateVersionintegerОбязательно- Может быть nullНе меньше 1
fromobjectОбязательноemailstringОбязательно- До 320 символов
namestring- До 120 символов
replyTostringОбязательно- Может быть nullДо 320 символов
subjectstringОбязательно- Может быть nullДо 300 символов
propsRecord<string, object>Обязательно
AutomationStarterListobject
objectstring- Одно из
"list"
AutomationStatsobject
objectstringОбязательно- Одно из
"automation_stats" automationIdstringОбязательноsincestringОбязательноWhere the window starts.
Форматdate-timeuntilstringОбязательноWhere the window ends.
Форматdate-timetotalsobjectОбязательноThe whole automation over the window.
enteredintegerContacts that entered.
Не меньше 0activeintegerContacts in it now, whatever the window.
Не меньше 0completedintegerContacts that reached the end of a path.
Не меньше 0exitedintegerContacts that left early.
Не меньше 0sentintegerEmails sent.
Не меньше 0deliveredintegerEmails delivered.
Не меньше 0openedintegerEmails opened. Many mail apps hide opens, so read it as a floor.
Не меньше 0clickedintegerEmails with a click.
Не меньше 0bouncedintegerEmails that bounced.
Не меньше 0complainedintegerEmails marked as spam.
Не меньше 0unsubscribedintegerContacts that unsubscribed from one of its emails.
Не меньше 0
stepsobject[]ОбязательноThe same numbers for each step.
stepKeystringThe
keyof the step.kindstring- Одно из
"send_email""wait""branch""add_to_audience""remove_from_audience""update_field""webhook""exit" enteredintegerContacts that reached the step.
Не меньше 0waitingintegerContacts sitting at the step now.
Не меньше 0completedintegerContacts whose path ended at the step.
Не меньше 0exitedintegerContacts that left early at the step.
Не меньше 0sentintegerEmails the step sent.
Не меньше 0skippedintegerTimes the step did nothing, such as an address that cannot receive mail.
Не меньше 0failedintegerTimes the step failed for good.
Не меньше 0yesintegerContacts a branch sent down yes.
Не меньше 0nointegerContacts a branch sent down no.
Не меньше 0deliveredintegerEmails of the step that were delivered.
Не меньше 0openedintegerEmails of the step that were opened.
Не меньше 0clickedintegerEmails of the step with a click.
Не меньше 0bouncedintegerEmails of the step that bounced.
Не меньше 0complainedintegerEmails of the step marked as spam.
Не меньше 0unsubscribedintegerContacts that unsubscribed from an email of the step.
Не меньше 0
seriesobject[]ОбязательноOne point for each UTC day in the window on which something happened, oldest first.
daystringThe start of the day, in UTC.
Форматdate-timeenteredintegerContacts that entered that day.
Не меньше 0completedintegerContacts that completed that day.
Не меньше 0exitedintegerContacts that left early that day.
Не меньше 0sentintegerEmails sent that day.
Не меньше 0
AutomationSummaryobject
objectstringОбязательно- Одно из
"automation" idstringОбязательноThe id of the automation. It never changes.
namestringОбязательноWhat the workspace calls it. Contacts never see it.
descriptionstringОбязательноA note for the workspace.
Может быть nullstatusstringОбязательноdraftuntil 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.Одно из"draft""live""paused""archived"triggerKindstringОбязательноWhat starts the draft, or null while it has no trigger.
Может быть nullОдно из"audience_joined""form_submitted""event""date""manual"stepCountintegerОбязательноHow many steps the draft holds.
Не меньше 0emailCountintegerОбязательноHow many of those steps send an email.
Не меньше 0hasUnpublishedChangesbooleanОбязательноTrue when the draft differs from the version that is running.
publishedVersionintegerОбязательноThe number of the version that is running. Null until the first publish.
Может быть nullpausedReasonstringОбязательноWhy 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.Может быть nullОдно из"manual""sender_refused""key_revoked""template_unavailable""audience_missing""plan_limit"lastErrorstringОбязательноWhat went wrong the last time OpenEmail paused it, in a sentence. Null otherwise.
Может быть nullcountsobjectОбязательноContacts, counted at the moment of the read.
activeintegerОбязательноIn the automation now.
Не меньше 0completedintegerОбязательноReached the end of a path, in all its time.
Не меньше 0exitedintegerОбязательноLeft before the end, in all its time.
Не меньше 0
createdBystringОбязательноThe user id of the person who made it. Null when that account is gone.
Может быть nullpublishedAtstringОбязательноThe last publish. Null until the first.
Может быть nullФорматdate-timepausedAtstringОбязательноWhen it was paused. Null while it is not.
Может быть nullФорматdate-timearchivedAtstringОбязательноWhen it was archived. Null otherwise.
Может быть nullФорматdate-timecreatedAtstringОбязательноWhen it was made.
Форматdate-timeupdatedAtstringОбязательноThe last save. Send it back as
expectedUpdatedAtso a change never overwrites one you have not seen.Форматdate-time
AutomationTestobject
objectstringОбязательно- Одно из
"automation_test" automationIdstringОбязательноemailIdstringОбязательноThe test email, as
GET /emails/{id}returns it.tostringОбязательноWhere it went.
ФорматemailstepKeystringОбязательноThe step that was sent.
AutomationVersionobject
objectstringОбязательно- Одно из
"automation_version" idstringОбязательноautomationIdstringОбязательноversionintegerОбязательноCounts up from 1 with each publish that changed the definition.
Не меньше 1definitionobjectОбязательноWhat 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.
triggerobjectОбязательноWhat puts a contact into the automation. Null in a draft that has none yet, and a draft cannot be published without one.
Может быть nullkindstringОбязательно- Одно из
"audience_joined" audienceIdstringОбязательно- До 64 символов
includeImportedbooleanОбязательно
entrystringОбязательноThe
keyof the first step, or null while the draft has no steps.Может быть nullШаблон^[a-z][a-z0-9]{2,23}$stepsobject[]ОбязательноEvery 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.До 50 элементовkeystringОбязательно- Шаблон
^[a-z][a-z0-9]{2,23}$ namestring- До 80 символов
kindstringОбязательно- Одно из
"send_email" nextstringОбязательно- Может быть nullШаблон
^[a-z][a-z0-9]{2,23}$ templateIdstringОбязательно- До 64 символов
templateVersionintegerОбязательно- Может быть nullНе меньше 1
fromobjectОбязательноemailstringОбязательно- До 320 символов
namestring- До 120 символов
replyTostringОбязательно- Может быть nullДо 320 символов
subjectstringОбязательно- Может быть nullДо 300 символов
propsRecord<string, object>Обязательно
currentbooleanОбязательноTrue for the version that is running.
createdBystringОбязательноThe user id of whoever published it.
Может быть nullcreatedAtstringОбязательноWhen it was published.
Форматdate-time
AutomationVersionListobject
objectstring- Одно из
"list"
DeletedAutomationobject
objectstringОбязательно- Одно из
"automation" idstringОбязательноdeletedbooleanОбязательно- Одно из
true