Automations

Marketing automations (abandoned cart, win-back, review requests, newsletters)

📄️ Create automation

Creates a marketing automation (abandoned cart, win-back, review request, segment campaign, transactional or newsletter). emailTemplateId is required when the EMAIL channel is enabled, whatsappTemplateId when WHATSAPP is enabled, segmentId for segment_campaign, and schedule for newsletter (which must use channels exactly ['EMAIL']).

📄️ List automations

Paginated list of the store's automations, filterable by type, status, free-text search and date range.

📄️ Get automation

Returns a single automation visible to the store (store-owned or global default).

📄️ Update automation

Partially updates an automation. All fields are optional; only provided fields are changed.

📄️ Delete automation

Deletes an automation. Only draft or paused, non-default automations can be deleted; active automations must be paused first and TakeTheme default automations can only be deactivated.

📄️ Activate automation

Sets the automation status to active. No request body.

📄️ Pause automation

Sets the automation status to paused. No request body.

📄️ Get automation stats

Returns the automation's denormalized stats rollup (sends, recoveries, revenue, clicks, conversions, opens).

📄️ Get click breakdown by CTA

Aggregates short-URL click counts per CTA label for the automation, scoped to this store's sends. Unknown labels are grouped under 'other'.

📄️ List automation activity logs

Paginated per-recipient send log for one automation, filterable by status (single or comma-separated list) and channel. Sorted newest-first on sentAt by default.