Enable automation workflow

post

https://api.omnisend.com/api/automations/{id}/enable

Enable an automation workflow. Once enabled, the workflow starts processing trigger events in real time.

The request body is optional. Use enrollExisting to also enroll contacts who already qualify at the time of enabling. When the body is omitted (or enrollExisting is omitted or false), only future trigger events are processed.

Enabling an already-enabled automation is idempotent — returns the current state without side effects.

Scopes: automations.write

Path Params

string

required

Automation workflow ID (24 character hexadecimal)

Body Params

Optional enable options

Enable an automation workflow. Once enabled, the workflow starts processing trigger events in real time. Use enrollExisting to also enroll contacts who already qualify at the time of enabling.

enrollExisting

boolean

Whether to enroll contacts who already meet the trigger conditions. When omitted or false, only future trigger events are processed.

When enrollExisting=true:

Event-based triggers (e.g. "placed order", "started checkout"): contacts whose trigger event occurred within the first delay block's time window are enrolled. They receive messages based on their original event time, not when the workflow was enabled (e.g. 30-day delay, event 20 days ago → message in 10 days). The workflow must start with a delay block — otherwise the request is rejected with 409 enroll-existing-not-applicable.
"Entered segment" trigger: all contacts currently in the trigger's segments are enrolled immediately. Takes effect only on the first enable; re-enabling with enrollExisting=true is rejected with 409 enroll-existing-not-applicable. Copy the workflow if a fresh enrollment is needed.
Birthday, "Product back in stock", and custom virtual events: not supported; enrollExisting=true is rejected with 409 enroll-existing-not-applicable.

Headers

Omnisend-Version

string

required

Defaults to 2026-03-15

API version that specifies the response format and behaviour

Responses

200Automation workflow in its new enabled state

400Request contains invalid or missing fields

401Authentication is missing or invalid

403Insufficient permissions for this operation

404Automation workflow not found

409Automation state prevents enabling

410API version has been retired

429Rate limit exceeded

500Unexpected error occurred