Sign in

v1

latestOpenAPI 3.0.02026-07-2664192238.8 KB
Automations

Disable automation workflow

Disable an automation workflow. Once disabled, the workflow stops accepting new trigger events.

Use contactsInWorkflow to control what happens to contacts currently progressing through the workflow:

  • keep: contacts remain and continue through the remaining blocks until completion. No new contacts enter.
  • exit: all contacts are immediately removed from the workflow. Contacts who have not yet received their messages will not receive them.

Disabling an already-disabled automation is idempotent — returns the current state without side effects.

Scopes: automations.write

post/automations/{id}/disable

Path parameters

idstring required

Automation workflow ID (24 character hexadecimal)

Headers

Omnisend-Versionstring required

API version that specifies the response format and behaviour

Request body

contactsInWorkflow'keep' | 'exit' required

What to do with contacts currently in the workflow

Example request

{
  "contactsInWorkflow": "keep"
}

Response

Automation workflow in its new disabled state

brandIDstring

Brand identifier (read-only)

createdAtstring

Automation creation timestamp (read-only)

disabledAtstring

Timestamp when automation was disabled (read-only)

enabledAtstring

Timestamp when automation was enabled (read-only)

idstring

Automation workflow unique identifier (read-only)

isEnabledboolean

Whether the automation workflow is enabled (read-only). Controlled via enable/disable actions.

namestring

Automation workflow name

updatedAtstring

Automation last update timestamp (read-only)