オートメーション
このグループのすべてのオペレーションの、受け付ける内容、返す内容、返しうるエラー。
オペレーション
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