Sign in

v1

latestOpenAPI 3.0.02026-07-2664192238.8 KB
Automations

Enable automation workflow

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

post/automations/{id}/enable

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

enrollExistingboolean

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.

Response

Automation workflow in its new enabled 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)