ऑटोमेशन
इस समूह का हर ऑपरेशन: वह क्या लेता है, क्या लौटाता है और किन त्रुटियों के साथ जवाब दे सकता है।
ऑपरेशन
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.
कम से कम 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.
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.
कम से कम 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.
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अधिकतम 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.
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.
कम से कम 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.
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.
कम से कम 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.
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.
कम से कम 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.
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.
कम से कम 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.
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