Automations

Intro

Endpoint: https://api.omnisend.com/v5/automations

This API allows you to retrieve a list of all automations in your account, including their current status, trigger events, and associated messages across email, SMS, and push channels.

Automation Status

Each automation can be in one of three states:

Status	Description
enabled	Automation is active and will send messages when triggered
disabled	Automation has been turned off and will not send messages
draft	Automation has been created but not yet activated

Response Fields

id: Unique identifier for the automation
name: Display name of the automation
status: Current state of the automation (see status table above)
trigger: The event or condition that starts this automation (e.g., "Welcome Series", "Abandoned Cart")
messages: Array of messages included in the automation workflow, each containing:
- id: Message identifier
- channel: Delivery channel (email, sms, or push)
- title: For emails, this is the subject line; for SMS, the message text; for push, the notification title
createdAt: When the automation was created (ISO 8601 format)
updatedAt: When the automation was last modified (ISO 8601 format)

Filtering

Use the updatedAtFrom query parameter to retrieve only automations that were updated after a specific date:

curl --request GET \
     --url 'https://api.omnisend.com/v5/automations?updatedAtFrom=2024-01-01T00:00:00Z' \
     --header 'X-API-KEY: YOUR_API_KEY' \
     --header 'accept: application/json'

Note: The date must be in ISO 8601 format (e.g., 2024-01-01T00:00:00Z)