API

Automações

Cada operação deste grupo: o que aceita, o que devolve e os erros com que pode responder.

Operações

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

automations:readLê

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.

Parâmetros de consulta

statusstring: Only automations in this state.
Um de"draft""live""paused""archived"
limitinteger: Rows per page, 1 to 100.
Pelo menos 1No máximo 100Predefinição50
cursorstring: The 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 400 invalid_cursor.

Devolve

200AutomationList

A page of automations.

Erros

Os erros que qualquer operação pode devolver400401403404422500Catálogo de erros

Também disponível em

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

automations:writeAltera dados

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.

Corpo do pedido

namestringObrigatório

What the workspace calls the automation, trimmed, 1 to 120 characters. Contacts never see it, and it need not be unique.

De 1 a 120 caracteres

descriptionstring

A note for the workspace, at most 500 characters. Contacts never see it.

Pode ser nullAté 500 caracteres

starterstring

Begin from a starter, by its slug: welcome-series, trial-follow-up, birthday or win-back. Ignored when definition is sent. A starter leaves the audience, the templates and the from address for you to fill in.

De 1 a 64 caracteres

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.

triggerobjectObrigatório

What puts a contact into the automation. Null in a draft that has none yet, and a draft cannot be published without one.

Pode ser null

kindstringObrigatório: Um de"audience_joined"
audienceIdstringObrigatório: Até 64 caracteres
includeImportedbooleanObrigatório

entrystringObrigatório

The key of the first step, or null while the draft has no steps.

Pode ser nullPadrão^[a-z][a-z0-9]{2,23}$

stepsobject[]Obrigatório

Every step, in any order. Each has a unique key, and names the step after it by key in next, or in yes and no for a branch. Null ends the path there.

Até 50 itens

keystringObrigatório

Padrão^[a-z][a-z0-9]{2,23}$

namestring

Até 80 caracteres

kindstringObrigatório

Um de"send_email"

nextstringObrigatório

Pode ser nullPadrão^[a-z][a-z0-9]{2,23}$

templateIdstringObrigatório

Até 64 caracteres

templateVersionintegerObrigatório

Pode ser nullPelo menos 1

fromobjectObrigatório

emailstringObrigatório: Até 320 caracteres
namestring: Até 120 caracteres

replyTostringObrigatório

Pode ser nullAté 320 caracteres

subjectstringObrigatório

Pode ser nullAté 300 caracteres

propsRecord<string, object>Obrigatório

settingsobject

How the automation runs: timezone, an IANA zone such as Europe/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, and listAudienceId, the audience unsubscribes are recorded in. Every field is optional.

timezonestring

De 1 a 64 caracteres

sendWindowobject

Pode ser null

daysinteger[]Obrigatório: Até 7 itens
startMinuteintegerObrigatório: Pelo menos 0No máximo 1440
endMinuteintegerObrigatório: Pelo menos 0No máximo 1440

reentryDaysinteger

Pode ser nullPelo menos 1No máximo 3650

exitOnLeaveboolean

listAudienceIdstring

Pode ser nullAté 64 caracteres

Devolve

201Automation

Created, as a draft.

Erros

422: invalid_parameter for a value of the wrong shape, unknown_parameter for a key the body does not take, invalid_automation for an unknown starter or a definition that breaks a rule of its structure, such as two steps with one key, or workspace_limit_reached when the workspace holds the most automations it may.

Os erros que qualquer operação pode devolver400401403404500Catálogo de erros

Também disponível em

TypeScript: automations.create()
Python: automations.create()
Ruby: automations.create
PHP: automations->create
Go: Automations.Create
Java: automations().create
C#: Automations.CreateAsync
CLI: openemail automations create
MCP: createAutomation

GET`/automations/starters`

List the automation starters

automations:readLê

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.

Devolve

200AutomationStarterList

Every starter.

Erros

Os erros que qualquer operação pode devolver400401403404422500Catálogo de erros

Também disponível em

TypeScript: automations.listStarters()
Python: automations.list_starters()
Ruby: automations.list_starters
PHP: automations->listStarters
Go: Automations.ListStarters
Java: automations().listStarters
C#: Automations.ListStartersAsync
CLI: openemail automations list-starters
MCP: listAutomationStarters

GET`/automations/{id}`

Retrieve an automation

automations:readLê

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.

Parâmetros de caminho

idstringObrigatório: The automation, such as aut_5c1e9a7b3d2f48e6a0b4c7d1, as GET /automations lists it.

Devolve

200Automation

The automation.

Erros

404: automation_not_found when the id names no automation you can reach.

Os erros que qualquer operação pode devolver400401403422500Catálogo de erros

Também disponível em

TypeScript: automations.get()
Python: automations.get()
Ruby: automations.get
PHP: automations->get
Go: Automations.Get
Java: automations().get
C#: Automations.GetAsync
CLI: openemail automations get
MCP: getAutomation

PATCH`/automations/{id}`

Update an automation

automations:writeAltera dados

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.

Parâmetros de caminho

idstringObrigatório: The automation, such as aut_5c1e9a7b3d2f48e6a0b4c7d1, as GET /automations lists it.

Corpo do pedido

namestring

What the workspace calls the automation, trimmed, 1 to 120 characters. Contacts never see it, and it need not be unique.

De 1 a 120 caracteres

descriptionstring

A note for the workspace, at most 500 characters. Contacts never see it.

Pode ser nullAté 500 caracteres

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.

triggerobjectObrigatório

What puts a contact into the automation. Null in a draft that has none yet, and a draft cannot be published without one.

Pode ser null

kindstringObrigatório: Um de"audience_joined"
audienceIdstringObrigatório: Até 64 caracteres
includeImportedbooleanObrigatório

entrystringObrigatório

The key of the first step, or null while the draft has no steps.

Pode ser nullPadrão^[a-z][a-z0-9]{2,23}$

stepsobject[]Obrigatório

Every step, in any order. Each has a unique key, and names the step after it by key in next, or in yes and no for a branch. Null ends the path there.

Até 50 itens

keystringObrigatório

Padrão^[a-z][a-z0-9]{2,23}$

namestring

Até 80 caracteres

kindstringObrigatório

Um de"send_email"

nextstringObrigatório

Pode ser nullPadrão^[a-z][a-z0-9]{2,23}$

templateIdstringObrigatório

Até 64 caracteres

templateVersionintegerObrigatório

Pode ser nullPelo menos 1

fromobjectObrigatório

emailstringObrigatório: Até 320 caracteres
namestring: Até 120 caracteres

replyTostringObrigatório

Pode ser nullAté 320 caracteres

subjectstringObrigatório

Pode ser nullAté 300 caracteres

propsRecord<string, object>Obrigatório

settingsobject

Merged field by field into the stored settings, and applied at once, without publishing. Send only the fields you are changing.

timezonestring

De 1 a 64 caracteres

sendWindowobject

Pode ser null

daysinteger[]Obrigatório: Até 7 itens
startMinuteintegerObrigatório: Pelo menos 0No máximo 1440
endMinuteintegerObrigatório: Pelo menos 0No máximo 1440

reentryDaysinteger

Pode ser nullPelo menos 1No máximo 3650

exitOnLeaveboolean

listAudienceIdstring

Pode ser nullAté 64 caracteres

expectedUpdatedAtstring

The updatedAt you read. When the automation was saved since, the call is refused with 409 version_conflict and nothing is written.

Formatodate-time

Devolve

200Automation

Saved.

Erros

404: automation_not_found when the id names no automation you can reach.
409: version_conflict: the automation was saved after expectedUpdatedAt. automation_archived: an archived automation cannot be changed. Nothing was written.
422: invalid_parameter for a value of the wrong shape, unknown_parameter for a key the body does not take, or invalid_automation when the definition breaks a rule of its structure or settings.listAudienceId names no audience.

Os erros que qualquer operação pode devolver400401403500Catálogo de erros

Também disponível em

TypeScript: automations.update()
Python: automations.update()
Ruby: automations.update
PHP: automations->update
Go: Automations.Update
Java: automations().update
C#: Automations.UpdateAsync
CLI: openemail automations update
MCP: updateAutomation

DELETE`/automations/{id}`

Delete an automation

automations:writeElimina

Pede um código de verificação

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.

Parâmetros de caminho

idstringObrigatório: The automation, such as aut_5c1e9a7b3d2f48e6a0b4c7d1, as GET /automations lists it.

Devolve

200DeletedAutomation

Deleted.

Erros

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 with POST /security/step-up, send it to POST /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_found when the id names no automation you can reach.

Os erros que qualquer operação pode devolver400401422500Catálogo de erros

Também disponível em

TypeScript: automations.delete()
Python: automations.delete()
Ruby: automations.delete
PHP: automations->delete
Go: Automations.Delete
Java: automations().delete
C#: Automations.DeleteAsync
CLI: openemail automations delete
MCP: deleteAutomation

POST`/automations/{id}/publish`

Publish an automation

automations:writeemails:sendEnvia e-mail

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.

Parâmetros de caminho

idstringObrigatório: The automation, such as aut_5c1e9a7b3d2f48e6a0b4c7d1, as GET /automations lists it.

Devolve

200Automation

Published and live.

Erros

403: automation_limit_reached when the plan covers no more live automations, or insufficient_scope.
404: automation_not_found when the id names no automation you can reach.
409: automation_archived: an archived automation cannot be published.
422: invalid_automation when the draft cannot run: the error carries problems, every problem that blocks it, each with a code, the path of the field, the stepKey and a message.

Os erros que qualquer operação pode devolver400401500Catálogo de erros

Também disponível em

TypeScript: automations.publish()
Python: automations.publish()
Ruby: automations.publish
PHP: automations->publish
Go: Automations.Publish
Java: automations().publish
C#: Automations.PublishAsync
CLI: openemail automations publish
MCP: publishAutomation

POST`/automations/{id}/pause`

Pause an automation

automations:writeAltera dados

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.

Parâmetros de caminho

idstringObrigatório: The automation, such as aut_5c1e9a7b3d2f48e6a0b4c7d1, as GET /automations lists it.

Devolve

200Automation

Paused.

Erros

404: automation_not_found when 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.

Os erros que qualquer operação pode devolver400401403422500Catálogo de erros

Também disponível em

TypeScript: automations.pause()
Python: automations.pause()
Ruby: automations.pause
PHP: automations->pause
Go: Automations.Pause
Java: automations().pause
C#: Automations.PauseAsync
CLI: openemail automations pause
MCP: pauseAutomation

POST`/automations/{id}/resume`

Resume an automation

automations:writeemails:sendEnvia e-mail

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.

Parâmetros de caminho

idstringObrigatório: The automation, such as aut_5c1e9a7b3d2f48e6a0b4c7d1, as GET /automations lists it.

Devolve

200Automation

Live again.

Erros

403: automation_limit_reached when the plan covers no more live automations, or insufficient_scope.
404: automation_not_found when 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_automation when the draft cannot run: the error carries problems, every problem that blocks it, each with a code, the path of the field, the stepKey and a message.

Os erros que qualquer operação pode devolver400401500Catálogo de erros

Também disponível em

TypeScript: automations.resume()
Python: automations.resume()
Ruby: automations.resume
PHP: automations->resume
Go: Automations.Resume
Java: automations().resume
C#: Automations.ResumeAsync
CLI: openemail automations resume
MCP: resumeAutomation

POST`/automations/{id}/archive`

Archive an automation

automations:writeElimina

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.

Parâmetros de caminho

idstringObrigatório: The automation, such as aut_5c1e9a7b3d2f48e6a0b4c7d1, as GET /automations lists it.

Devolve

200Automation

Archived.

Erros

404: automation_not_found when the id names no automation you can reach.

Os erros que qualquer operação pode devolver400401403422500Catálogo de erros

Também disponível em

TypeScript: automations.archive()
Python: automations.archive()
Ruby: automations.archive
PHP: automations->archive
Go: Automations.Archive
Java: automations().archive
C#: Automations.ArchiveAsync
CLI: openemail automations archive
MCP: archiveAutomation

POST`/automations/{id}/duplicate`

Duplicate an automation

automations:writeAltera dados

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.

Parâmetros de caminho

idstringObrigatório: The automation, such as aut_5c1e9a7b3d2f48e6a0b4c7d1, as GET /automations lists it.

Devolve

201Automation

The copy, as a draft.

Erros

404: automation_not_found when the id names no automation you can reach.
422: workspace_limit_reached when the workspace holds the most automations it may.

Os erros que qualquer operação pode devolver400401403500Catálogo de erros

Também disponível em

TypeScript: automations.duplicate()
Python: automations.duplicate()
Ruby: automations.duplicate
PHP: automations->duplicate
Go: Automations.Duplicate
Java: automations().duplicate
C#: Automations.DuplicateAsync
CLI: openemail automations duplicate
MCP: duplicateAutomation

POST`/automations/{id}/test`

Send a test of one email step

automations:writeemails:sendEnvia e-mail

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.

Parâmetros de caminho

idstringObrigatório: The automation, such as aut_5c1e9a7b3d2f48e6a0b4c7d1, as GET /automations lists it.

Corpo do pedido

stepKeystringObrigatório: The key of the email step to send, from the draft definition.
De 1 a 64 caracteres
tostring: Where the test goes. Left out, it goes to the account email of the person the key or app acts for.
Até 320 caracteresFormatoemail

Devolve

200AutomationTest

Sent.

Erros

403: from_address_forbidden when the caller may not send as the from address of the step, or insufficient_scope.
404: automation_not_found when the id names no automation you can reach.
409: domain_not_sendable when the domain of the from address cannot send yet.
422: invalid_automation when stepKey names no step, the step is not an email, or its template cannot be sent, with param set to stepKey.
429: send_quota_exceeded: the monthly sends of the plan are used up.

Os erros que qualquer operação pode devolver400401500Catálogo de erros

Também disponível em

TypeScript: automations.sendTest()
Python: automations.send_test()
Ruby: automations.send_test
PHP: automations->sendTest
Go: Automations.SendTest
Java: automations().sendTest
C#: Automations.SendTestAsync
CLI: openemail automations send-test
MCP: sendAutomationTest

GET`/automations/{id}/versions`

List the versions of an automation

automations:readLê

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.

Parâmetros de caminho

idstringObrigatório: The automation, such as aut_5c1e9a7b3d2f48e6a0b4c7d1, as GET /automations lists it.

Devolve

200AutomationVersionList

The versions.

Erros

404: automation_not_found when the id names no automation you can reach.

Os erros que qualquer operação pode devolver400401403422500Catálogo de erros

Também disponível em

TypeScript: automations.listVersions()
Python: automations.list_versions()
Ruby: automations.list_versions
PHP: automations->listVersions
Go: Automations.ListVersions
Java: automations().listVersions
C#: Automations.ListVersionsAsync
CLI: openemail automations list-versions
MCP: listAutomationVersions

POST`/automations/{id}/versions/{version}/restore`

Restore a version into the draft

automations:writeAltera dados

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.

Parâmetros de caminho

idstringObrigatório: The automation, such as aut_5c1e9a7b3d2f48e6a0b4c7d1, as GET /automations lists it.
versionintegerObrigatório: The number of the version, as GET /automations/{id}/versions lists it.
Pelo menos 1

Devolve

200Automation

The automation, with the version in its draft.

Erros

404: automation_not_found when the id names no automation you can reach, or, with param set to version, when it has no such version.
409: automation_archived: an archived automation cannot be changed.

Os erros que qualquer operação pode devolver400401403422500Catálogo de erros

Também disponível em

TypeScript: automations.restoreVersion()
Python: automations.restore_version()
Ruby: automations.restore_version
PHP: automations->restoreVersion
Go: Automations.RestoreVersion
Java: automations().restoreVersion
C#: Automations.RestoreVersionAsync
CLI: openemail automations restore-version
MCP: restoreAutomationVersion

GET`/automations/{id}/stats`

How an automation has performed

automations:readLê

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.

Parâmetros de caminho

idstringObrigatório: The automation, such as aut_5c1e9a7b3d2f48e6a0b4c7d1, as GET /automations lists it.

Parâmetros de consulta

sincestring: Where the window starts, as an ISO 8601 instant. Left out, 30 days before until. It reaches back at most 366 days before until.
Formatodate-time
untilstring: Where the window ends, as an ISO 8601 instant. Left out, now.
Formatodate-time

Devolve

200AutomationStats

The numbers for the window.

Erros

404: automation_not_found when the id names no automation you can reach.
422: invalid_parameter when a time is not an ISO 8601 instant or until is not after since.

Os erros que qualquer operação pode devolver400401403500Catálogo de erros

Também disponível em

TypeScript: automations.stats()
Python: automations.stats()
Ruby: automations.stats
PHP: automations->stats
Go: Automations.Stats
Java: automations().stats
C#: Automations.StatsAsync
CLI: openemail automations stats
MCP: getAutomationStats

GET`/automations/{id}/enrollments`

List the contacts in an automation

automations:readLê

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.

Parâmetros de caminho

idstringObrigatório: The automation, such as aut_5c1e9a7b3d2f48e6a0b4c7d1, as GET /automations lists it.

Parâmetros de consulta

statusstring: Only enrollments in this state.
Um de"active""completed""exited"
stepKeystring: Only contacts at the step with this key.
De 1 a 64 caracteres
qstring: Only contacts whose address or name contains this text, compared without case.
Até 200 caracteres
limitinteger: Rows per page, 1 to 200.
Pelo menos 1No máximo 200Predefinição50
cursorstring: The 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 400 invalid_cursor.

Devolve

200AutomationEnrollmentList

A page of enrollments.

Erros

404: automation_not_found when the id names no automation you can reach.

Os erros que qualquer operação pode devolver400401403422500Catálogo de erros

Também disponível em

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

automations:writeEnvia e-mail

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.

Parâmetros de caminho

idstringObrigatório: The automation, such as aut_5c1e9a7b3d2f48e6a0b4c7d1, as GET /automations lists it.

Corpo do pedido

contactIdstring: The contact, by id. Send this or email, never both.
De 1 a 64 caracteres
emailstring: The contact, by email address. Send this or contactId, never both.
Até 320 caracteresFormatoemail
dataRecord<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.

Devolve

201AutomationEnrollment

Enrolled, and due at the first step.

Erros

404: automation_not_found, or contact_not_found when no contact has that id or address.
409: automation_not_live when it is a draft, paused or archived. already_enrolled when the contact is in it or finished it too recently. contact_unreachable when the address is suppressed or unsubscribed.
422: invalid_parameter when neither or both of contactId and email are sent, or data is too large.

Os erros que qualquer operação pode devolver400401403500Catálogo de erros

Também disponível em

TypeScript: automations.enroll()
Python: automations.enroll()
Ruby: automations.enroll
PHP: automations->enroll
Go: Automations.Enroll
Java: automations().enroll
C#: Automations.EnrollAsync
CLI: openemail automations enroll
MCP: enrollInAutomation

GET`/automations/{id}/enrollments/{enrollmentId}`

Retrieve an enrollment

automations:readLê

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.

Parâmetros de caminho

idstringObrigatório: The automation, such as aut_5c1e9a7b3d2f48e6a0b4c7d1, as GET /automations lists it.
enrollmentIdstringObrigatório: The enrollment, such as aen_2b8d4f6a1c3e5079b6d8f0a2, as GET /automations/{id}/enrollments lists it.

Devolve

200AutomationEnrollmentDetail

The enrollment with its runs.

Erros

404: automation_not_found or automation_enrollment_not_found.

Os erros que qualquer operação pode devolver400401403422500Catálogo de erros

Também disponível em

TypeScript: automations.getEnrollment()
Python: automations.get_enrollment()
Ruby: automations.get_enrollment
PHP: automations->getEnrollment
Go: Automations.GetEnrollment
Java: automations().getEnrollment
C#: Automations.GetEnrollmentAsync
CLI: openemail automations get-enrollment
MCP: getAutomationEnrollment

POST`/automations/{id}/enrollments/{enrollmentId}/exit`

Take a contact out of an automation

automations:writeElimina

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.

Parâmetros de caminho

idstringObrigatório: The automation, such as aut_5c1e9a7b3d2f48e6a0b4c7d1, as GET /automations lists it.
enrollmentIdstringObrigatório: The enrollment, such as aen_2b8d4f6a1c3e5079b6d8f0a2, as GET /automations/{id}/enrollments lists it.

Devolve

200AutomationEnrollment

The enrollment, exited.

Erros

404: automation_not_found or automation_enrollment_not_found.
409: automation_enrollment_finished: the contact already completed or left.

Os erros que qualquer operação pode devolver400401403422500Catálogo de erros

Também disponível em

TypeScript: automations.exitEnrollment()
Python: automations.exit_enrollment()
Ruby: automations.exit_enrollment
PHP: automations->exitEnrollment
Go: Automations.ExitEnrollment
Java: automations().exitEnrollment
C#: Automations.ExitEnrollmentAsync
CLI: openemail automations exit-enrollment
MCP: removeFromAutomation

Objetos

`Automation`object

objectstringObrigatório

Um de"automation"

idstringObrigatório

The id of the automation. It never changes.

namestringObrigatório

What the workspace calls it. Contacts never see it.

descriptionstringObrigatório

A note for the workspace.

Pode ser null

statusstringObrigatório

draft until the first publish. live takes contacts in and moves them along. paused takes nobody in and holds everyone where they are. archived is retired for good and everyone in it has left.

Um de"draft""live""paused""archived"

triggerKindstringObrigatório

What starts the draft, or null while it has no trigger.

Pode ser nullUm de"audience_joined""form_submitted""event""date""manual"

stepCountintegerObrigatório

How many steps the draft holds.

Pelo menos 0

emailCountintegerObrigatório

How many of those steps send an email.

Pelo menos 0

hasUnpublishedChangesbooleanObrigatório

True when the draft differs from the version that is running.

publishedVersionintegerObrigatório

The number of the version that is running. Null until the first publish.

Pode ser null

pausedReasonstringObrigatório

Why it is paused. manual is a person. The others are OpenEmail stopping it: sender_refused when its from address can no longer send, key_revoked when the API key that published it was revoked, expired or turned off, template_unavailable when one of its templates can no longer be sent, audience_missing when an audience it depends on is gone, and plan_limit when the plan no longer covers this many live automations. Null while it is not paused.

Pode ser nullUm de"manual""sender_refused""key_revoked""template_unavailable""audience_missing""plan_limit"

lastErrorstringObrigatório

What went wrong the last time OpenEmail paused it, in a sentence. Null otherwise.

Pode ser null

countsobjectObrigatório

Contacts, counted at the moment of the read.

activeintegerObrigatório: In the automation now.
Pelo menos 0
completedintegerObrigatório: Reached the end of a path, in all its time.
Pelo menos 0
exitedintegerObrigatório: Left before the end, in all its time.
Pelo menos 0

createdBystringObrigatório

The user id of the person who made it. Null when that account is gone.

Pode ser null

publishedAtstringObrigatório

The last publish. Null until the first.

Pode ser nullFormatodate-time

pausedAtstringObrigatório

When it was paused. Null while it is not.

Pode ser nullFormatodate-time

archivedAtstringObrigatório

When it was archived. Null otherwise.

Pode ser nullFormatodate-time

createdAtstringObrigatório

When it was made.

Formatodate-time

updatedAtstringObrigatório

The last save. Send it back as expectedUpdatedAt so a change never overwrites one you have not seen.

Formatodate-time

definitionobjectObrigatório

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.

triggerobjectObrigatório

What puts a contact into the automation. Null in a draft that has none yet, and a draft cannot be published without one.

Pode ser null

kindstringObrigatório: Um de"audience_joined"
audienceIdstringObrigatório: Até 64 caracteres
includeImportedbooleanObrigatório

entrystringObrigatório

The key of the first step, or null while the draft has no steps.

Pode ser nullPadrão^[a-z][a-z0-9]{2,23}$

stepsobject[]Obrigatório

Every step, in any order. Each has a unique key, and names the step after it by key in next, or in yes and no for a branch. Null ends the path there.

Até 50 itens

keystringObrigatório

Padrão^[a-z][a-z0-9]{2,23}$

namestring

Até 80 caracteres

kindstringObrigatório

Um de"send_email"

nextstringObrigatório

Pode ser nullPadrão^[a-z][a-z0-9]{2,23}$

templateIdstringObrigatório

Até 64 caracteres

templateVersionintegerObrigatório

Pode ser nullPelo menos 1

fromobjectObrigatório

emailstringObrigatório: Até 320 caracteres
namestring: Até 120 caracteres

replyTostringObrigatório

Pode ser nullAté 320 caracteres

subjectstringObrigatório

Pode ser nullAté 300 caracteres

propsRecord<string, object>Obrigatório

publishedobjectObrigatório

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.

Pode ser null

triggerobjectObrigatório

What puts a contact into the automation. Null in a draft that has none yet, and a draft cannot be published without one.

Pode ser null

kindstringObrigatório: Um de"audience_joined"
audienceIdstringObrigatório: Até 64 caracteres
includeImportedbooleanObrigatório

entrystringObrigatório

The key of the first step, or null while the draft has no steps.

Pode ser nullPadrão^[a-z][a-z0-9]{2,23}$

stepsobject[]Obrigatório

Every step, in any order. Each has a unique key, and names the step after it by key in next, or in yes and no for a branch. Null ends the path there.

Até 50 itens

keystringObrigatório

Padrão^[a-z][a-z0-9]{2,23}$

namestring

Até 80 caracteres

kindstringObrigatório

Um de"send_email"

nextstringObrigatório

Pode ser nullPadrão^[a-z][a-z0-9]{2,23}$

templateIdstringObrigatório

Até 64 caracteres

templateVersionintegerObrigatório

Pode ser nullPelo menos 1

fromobjectObrigatório

emailstringObrigatório: Até 320 caracteres
namestring: Até 120 caracteres

replyTostringObrigatório

Pode ser nullAté 320 caracteres

subjectstringObrigatório

Pode ser nullAté 300 caracteres

propsRecord<string, object>Obrigatório

settingsobjectObrigatório

How it runs. Settings take effect when they are saved, published or not.

timezonestringObrigatório

The IANA time zone the sending window and waits until a day and time are read in, such as Europe/London. UTC until you set one.

De 1 a 64 caracteres

sendWindowobjectObrigatório

When emails may go out: days of the week (0 is Sunday) and startMinute to endMinute of the day, counted from midnight. An email due outside it waits for the window to open. Null sends at any time.

Pode ser null

daysinteger[]Obrigatório: Até 7 itens
startMinuteintegerObrigatório: Pelo menos 0No máximo 1440
endMinuteintegerObrigatório: Pelo menos 0No máximo 1440

reentryDaysintegerObrigatório

How many days after a contact finishes before they may enter again. Null lets each contact through once only.

Pode ser nullPelo menos 1No máximo 3650

exitOnLeavebooleanObrigatório

Take a contact out when they leave the audience that started the automation. True by default.

listAudienceIdstringObrigatório

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.

Pode ser nullAté 64 caracteres

problemsAutomationProblem[]Obrigatório

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.

`AutomationEnrollment`object

objectstringObrigatório

Um de"automation_enrollment"

idstringObrigatório

The id of the enrollment.

automationIdstringObrigatório

versionintegerObrigatório

The published version the contact entered on and stays on. Null when that version is gone.

Pode ser null

contactobjectObrigatório

idstringObrigatório: The id of the contact.
emailstringObrigatório: Formatoemail
namestringObrigatório: Pode ser null

statusstringObrigatório

active while the contact is in it, completed at the end of a path, exited when they left early.

Um de"active""completed""exited"

sourcestringObrigatório

How they got in: trigger, by hand in the app (manual), or through this API or an app (api).

Um de"trigger""manual""api"

stepKeystringObrigatório

The key of the step the contact is at, or was at when they finished. Null before the first step.

Pode ser null

waitingbooleanObrigatório

True while the contact sits in a wait step.

waitingForEventstringObrigatório

The event name a wait step is holding out for. Null otherwise.

Pode ser null

heldForstringObrigatório

Why a step that is due has not run: window for the sending window, quota for the monthly sends, lane when the broadcast lane of the workspace is paused, retry after a failure that is tried again. Null when nothing holds it.

Pode ser nullUm de"window""quota""lane""retry"

nextRunAtstringObrigatório

When the contact moves next. Null once they finished.

Pode ser nullFormatodate-time

exitReasonstringObrigatório

How it ended: completed, an exit step (exit_step), unsubscribed, suppressed, left_audience, taken out by a person or a call (removed), the automation was archived, or a step failed for good. Null while active.

Pode ser nullUm de"completed""exit_step""unsubscribed""suppressed""left_audience""removed""archived""failed"

lastErrorstringObrigatório

The last failure of a step, in a sentence.

Pode ser null

startedAtstringObrigatório

When the contact entered.

Formatodate-time

finishedAtstringObrigatório

When they completed or left. Null while active.

Pode ser nullFormatodate-time

updatedAtstringObrigatório

The last time anything about the enrollment changed.

Formatodate-time

`AutomationEnrollmentDetail`object

objectstringObrigatório

Um de"automation_enrollment"

idstringObrigatório

The id of the enrollment.

automationIdstringObrigatório

versionintegerObrigatório

The published version the contact entered on and stays on. Null when that version is gone.

Pode ser null

contactobjectObrigatório

idstringObrigatório: The id of the contact.
emailstringObrigatório: Formatoemail
namestringObrigatório: Pode ser null

statusstringObrigatório

active while the contact is in it, completed at the end of a path, exited when they left early.

Um de"active""completed""exited"

sourcestringObrigatório

How they got in: trigger, by hand in the app (manual), or through this API or an app (api).

Um de"trigger""manual""api"

stepKeystringObrigatório

The key of the step the contact is at, or was at when they finished. Null before the first step.

Pode ser null

waitingbooleanObrigatório

True while the contact sits in a wait step.

waitingForEventstringObrigatório

The event name a wait step is holding out for. Null otherwise.

Pode ser null

heldForstringObrigatório

Pode ser nullUm de"window""quota""lane""retry"

nextRunAtstringObrigatório

When the contact moves next. Null once they finished.

Pode ser nullFormatodate-time

exitReasonstringObrigatório

Pode ser nullUm de"completed""exit_step""unsubscribed""suppressed""left_audience""removed""archived""failed"

lastErrorstringObrigatório

The last failure of a step, in a sentence.

Pode ser null

startedAtstringObrigatório

When the contact entered.

Formatodate-time

finishedAtstringObrigatório

When they completed or left. Null while active.

Pode ser nullFormatodate-time

updatedAtstringObrigatório

The last time anything about the enrollment changed.

Formatodate-time

runsobject[]Obrigatório

What each step did for the contact, oldest first.

idstringObrigatório
stepKeystringObrigatório: The key of the step that ran.
kindstringObrigatório: Um de"send_email""wait""branch""add_to_audience""remove_from_audience""update_field""webhook""exit"
outcomestringObrigatório: What happened: an email sent, a wait waited out, a branch answered yes or no, the contact added to or removed from an audience, a field updated, a webhook called, the path exited, the step skipped, or it failed.
Um de"sent""skipped""waited""yes""no""added""removed""updated""called""exited""failed"
emailIdstringObrigatório: The email a send step sent, as GET /emails lists it. Null for every other step.
Pode ser null
detailstringObrigatório: Why a step was skipped or failed, or how a wait ended.
Pode ser null
createdAtstringObrigatório: When the step ran.
Formatodate-time

`AutomationEnrollmentList`object

objectstring: Um de"list"
dataAutomationEnrollment[]
hasMoreboolean: True when another page follows. Pass nextCursor back as cursor to read it.
nextCursorstring: The id of the last row on this page, or null on the last page.
Pode ser null
automationIdstring: The automation the enrollments belong to.

`AutomationList`object

objectstring: Um de"list"
dataAutomationSummary[]
hasMoreboolean: True when another page follows. Pass nextCursor back as cursor to read it.
nextCursorstring: The id of the last row on this page, or null on the last page.
Pode ser null

`AutomationProblem`object

codestringObrigatório: What is wrong, for a program to branch on.
Um de"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"
pathstringObrigatório: The field at fault, dotted, such as definition.steps.2.templateId or settings.timezone.
stepKeystringObrigatório: The key of the step at fault. Null when it is the trigger or a setting.
Pode ser null
messagestringObrigatório: The problem in a sentence a person can act on.
blockingbooleanObrigatório: True when it stops a publish. False for a warning, such as a branch on opens.

`AutomationStarter`object

objectstringObrigatório

Um de"automation_starter"

slugstringObrigatório

What POST /automations takes as starter.

namestringObrigatório

descriptionstringObrigatório

What the starter is for, in a sentence.

definitionobjectObrigatório

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.

triggerobjectObrigatório

What puts a contact into the automation. Null in a draft that has none yet, and a draft cannot be published without one.

Pode ser null

kindstringObrigatório: Um de"audience_joined"
audienceIdstringObrigatório: Até 64 caracteres
includeImportedbooleanObrigatório

entrystringObrigatório

The key of the first step, or null while the draft has no steps.

Pode ser nullPadrão^[a-z][a-z0-9]{2,23}$

stepsobject[]Obrigatório

Every step, in any order. Each has a unique key, and names the step after it by key in next, or in yes and no for a branch. Null ends the path there.

Até 50 itens

keystringObrigatório

Padrão^[a-z][a-z0-9]{2,23}$

namestring

Até 80 caracteres

kindstringObrigatório

Um de"send_email"

nextstringObrigatório

Pode ser nullPadrão^[a-z][a-z0-9]{2,23}$

templateIdstringObrigatório

Até 64 caracteres

templateVersionintegerObrigatório

Pode ser nullPelo menos 1

fromobjectObrigatório

emailstringObrigatório: Até 320 caracteres
namestring: Até 120 caracteres

replyTostringObrigatório

Pode ser nullAté 320 caracteres

subjectstringObrigatório

Pode ser nullAté 300 caracteres

propsRecord<string, object>Obrigatório

`AutomationStarterList`object

objectstring: Um de"list"
dataAutomationStarter[]

`AutomationStats`object

objectstringObrigatório

Um de"automation_stats"

automationIdstringObrigatório

sincestringObrigatório

Where the window starts.

Formatodate-time

untilstringObrigatório

Where the window ends.

Formatodate-time

totalsobjectObrigatório

The whole automation over the window.

enteredinteger: Contacts that entered.
Pelo menos 0
activeinteger: Contacts in it now, whatever the window.
Pelo menos 0
completedinteger: Contacts that reached the end of a path.
Pelo menos 0
exitedinteger: Contacts that left early.
Pelo menos 0
sentinteger: Emails sent.
Pelo menos 0
deliveredinteger: Emails delivered.
Pelo menos 0
openedinteger: Emails opened. Many mail apps hide opens, so read it as a floor.
Pelo menos 0
clickedinteger: Emails with a click.
Pelo menos 0
bouncedinteger: Emails that bounced.
Pelo menos 0
complainedinteger: Emails marked as spam.
Pelo menos 0
unsubscribedinteger: Contacts that unsubscribed from one of its emails.
Pelo menos 0

stepsobject[]Obrigatório

The same numbers for each step.

stepKeystring: The key of the step.
kindstring: Um de"send_email""wait""branch""add_to_audience""remove_from_audience""update_field""webhook""exit"
enteredinteger: Contacts that reached the step.
Pelo menos 0
waitinginteger: Contacts sitting at the step now.
Pelo menos 0
completedinteger: Contacts whose path ended at the step.
Pelo menos 0
exitedinteger: Contacts that left early at the step.
Pelo menos 0
sentinteger: Emails the step sent.
Pelo menos 0
skippedinteger: Times the step did nothing, such as an address that cannot receive mail.
Pelo menos 0
failedinteger: Times the step failed for good.
Pelo menos 0
yesinteger: Contacts a branch sent down yes.
Pelo menos 0
nointeger: Contacts a branch sent down no.
Pelo menos 0
deliveredinteger: Emails of the step that were delivered.
Pelo menos 0
openedinteger: Emails of the step that were opened.
Pelo menos 0
clickedinteger: Emails of the step with a click.
Pelo menos 0
bouncedinteger: Emails of the step that bounced.
Pelo menos 0
complainedinteger: Emails of the step marked as spam.
Pelo menos 0
unsubscribedinteger: Contacts that unsubscribed from an email of the step.
Pelo menos 0

seriesobject[]Obrigatório

One point for each UTC day in the window on which something happened, oldest first.

daystring: The start of the day, in UTC.
Formatodate-time
enteredinteger: Contacts that entered that day.
Pelo menos 0
completedinteger: Contacts that completed that day.
Pelo menos 0
exitedinteger: Contacts that left early that day.
Pelo menos 0
sentinteger: Emails sent that day.
Pelo menos 0

`AutomationSummary`object

objectstringObrigatório

Um de"automation"

idstringObrigatório

The id of the automation. It never changes.

namestringObrigatório

What the workspace calls it. Contacts never see it.

descriptionstringObrigatório

A note for the workspace.

Pode ser null

statusstringObrigatório

draft until the first publish. live takes contacts in and moves them along. paused takes nobody in and holds everyone where they are. archived is retired for good and everyone in it has left.

Um de"draft""live""paused""archived"

triggerKindstringObrigatório

What starts the draft, or null while it has no trigger.

Pode ser nullUm de"audience_joined""form_submitted""event""date""manual"

stepCountintegerObrigatório

How many steps the draft holds.

Pelo menos 0

emailCountintegerObrigatório

How many of those steps send an email.

Pelo menos 0

hasUnpublishedChangesbooleanObrigatório

True when the draft differs from the version that is running.

publishedVersionintegerObrigatório

The number of the version that is running. Null until the first publish.

Pode ser null

pausedReasonstringObrigatório

Pode ser nullUm de"manual""sender_refused""key_revoked""template_unavailable""audience_missing""plan_limit"

lastErrorstringObrigatório

What went wrong the last time OpenEmail paused it, in a sentence. Null otherwise.

Pode ser null

countsobjectObrigatório

Contacts, counted at the moment of the read.

activeintegerObrigatório: In the automation now.
Pelo menos 0
completedintegerObrigatório: Reached the end of a path, in all its time.
Pelo menos 0
exitedintegerObrigatório: Left before the end, in all its time.
Pelo menos 0

createdBystringObrigatório

The user id of the person who made it. Null when that account is gone.

Pode ser null

publishedAtstringObrigatório

The last publish. Null until the first.

Pode ser nullFormatodate-time

pausedAtstringObrigatório

When it was paused. Null while it is not.

Pode ser nullFormatodate-time

archivedAtstringObrigatório

When it was archived. Null otherwise.

Pode ser nullFormatodate-time

createdAtstringObrigatório

When it was made.

Formatodate-time

updatedAtstringObrigatório

The last save. Send it back as expectedUpdatedAt so a change never overwrites one you have not seen.

Formatodate-time

`AutomationTest`object

objectstringObrigatório: Um de"automation_test"
automationIdstringObrigatório
emailIdstringObrigatório: The test email, as GET /emails/{id} returns it.
tostringObrigatório: Where it went.
Formatoemail
stepKeystringObrigatório: The step that was sent.

`AutomationVersion`object

objectstringObrigatório

Um de"automation_version"

idstringObrigatório

automationIdstringObrigatório

versionintegerObrigatório

Counts up from 1 with each publish that changed the definition.

Pelo menos 1

definitionobjectObrigatório

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.

triggerobjectObrigatório

What puts a contact into the automation. Null in a draft that has none yet, and a draft cannot be published without one.

Pode ser null

kindstringObrigatório: Um de"audience_joined"
audienceIdstringObrigatório: Até 64 caracteres
includeImportedbooleanObrigatório

entrystringObrigatório

The key of the first step, or null while the draft has no steps.

Pode ser nullPadrão^[a-z][a-z0-9]{2,23}$

stepsobject[]Obrigatório

Every step, in any order. Each has a unique key, and names the step after it by key in next, or in yes and no for a branch. Null ends the path there.

Até 50 itens

keystringObrigatório

Padrão^[a-z][a-z0-9]{2,23}$

namestring

Até 80 caracteres

kindstringObrigatório

Um de"send_email"

nextstringObrigatório

Pode ser nullPadrão^[a-z][a-z0-9]{2,23}$

templateIdstringObrigatório

Até 64 caracteres

templateVersionintegerObrigatório

Pode ser nullPelo menos 1

fromobjectObrigatório

emailstringObrigatório: Até 320 caracteres
namestring: Até 120 caracteres

replyTostringObrigatório

Pode ser nullAté 320 caracteres

subjectstringObrigatório

Pode ser nullAté 300 caracteres

propsRecord<string, object>Obrigatório

currentbooleanObrigatório

True for the version that is running.

createdBystringObrigatório

The user id of whoever published it.

Pode ser null

createdAtstringObrigatório

When it was published.

Formatodate-time

`AutomationVersionList`object

objectstring: Um de"list"
dataAutomationVersion[]

`DeletedAutomation`object

objectstringObrigatório: Um de"automation"
idstringObrigatório
deletedbooleanObrigatório: Um detrue