자동화
이 그룹의 모든 작업: 받는 값, 반환하는 값, 응답할 수 있는 오류.
작업
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.
null 가능kindstring필수- 다음 중 하나
"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.
null 가능kindstring필수- 다음 중 하나
"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.
null 가능statusstring필수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.
0 이상emailCountinteger필수How many of those steps send an email.
0 이상hasUnpublishedChangesboolean필수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.
null 가능pausedReasonstring필수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.
null 가능countsobject필수Contacts, counted at the moment of the read.
activeinteger필수In the automation now.
0 이상completedinteger필수Reached the end of a path, in all its time.
0 이상exitedinteger필수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.
null 가능publishedAtstring필수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.
null 가능kindstring필수- 다음 중 하나
"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.
null 가능triggerobject필수What puts a contact into the automation. Null in a draft that has none yet, and a draft cannot be published without one.
null 가능kindstring필수- 다음 중 하나
"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.null 가능daysinteger[]필수- 최대 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 이상3650 이하exitOnLeaveboolean필수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.
null 가능contactobject필수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.null 가능waitingboolean필수True while the contact sits in a wait step.
waitingForEventstring필수The event name a wait step is holding out for. Null otherwise.
null 가능heldForstring필수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.
null 가능startedAtstring필수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.
null 가능contactobject필수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.null 가능waitingboolean필수True while the contact sits in a wait step.
waitingForEventstring필수The event name a wait step is holding out for. Null otherwise.
null 가능heldForstring필수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.
null 가능startedAtstring필수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.null 가능detailstring필수Why a step was skipped or failed, or how a wait ended.
null 가능createdAtstring필수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.
null 가능automationIdstringThe 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.null 가능messagestring필수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.
null 가능kindstring필수- 다음 중 하나
"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.
0 이상activeintegerContacts in it now, whatever the window.
0 이상completedintegerContacts that reached the end of a path.
0 이상exitedintegerContacts that left early.
0 이상sentintegerEmails sent.
0 이상deliveredintegerEmails delivered.
0 이상openedintegerEmails opened. Many mail apps hide opens, so read it as a floor.
0 이상clickedintegerEmails with a click.
0 이상bouncedintegerEmails that bounced.
0 이상complainedintegerEmails marked as spam.
0 이상unsubscribedintegerContacts 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.
0 이상waitingintegerContacts sitting at the step now.
0 이상completedintegerContacts whose path ended at the step.
0 이상exitedintegerContacts that left early at the step.
0 이상sentintegerEmails the step sent.
0 이상skippedintegerTimes the step did nothing, such as an address that cannot receive mail.
0 이상failedintegerTimes the step failed for good.
0 이상yesintegerContacts a branch sent down yes.
0 이상nointegerContacts a branch sent down no.
0 이상deliveredintegerEmails of the step that were delivered.
0 이상openedintegerEmails of the step that were opened.
0 이상clickedintegerEmails of the step with a click.
0 이상bouncedintegerEmails of the step that bounced.
0 이상complainedintegerEmails of the step marked as spam.
0 이상unsubscribedintegerContacts 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.
0 이상completedintegerContacts that completed that day.
0 이상exitedintegerContacts that left early that day.
0 이상sentintegerEmails 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.
null 가능statusstring필수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.
0 이상emailCountinteger필수How many of those steps send an email.
0 이상hasUnpublishedChangesboolean필수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.
null 가능pausedReasonstring필수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.
null 가능countsobject필수Contacts, counted at the moment of the read.
activeinteger필수In the automation now.
0 이상completedinteger필수Reached the end of a path, in all its time.
0 이상exitedinteger필수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.
null 가능publishedAtstring필수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.
1 이상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.
null 가능kindstring필수- 다음 중 하나
"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.
null 가능createdAtstring필수When it was published.
형식date-time
AutomationVersionListobject
objectstring- 다음 중 하나
"list"
DeletedAutomationobject
objectstring필수- 다음 중 하나
"automation" idstring필수deletedboolean필수- 다음 중 하나
true