Sequences API
The sequences resource lets external systems prepare, migrate, or synchronize time-based email series. This guide explains how to think about sequence definitions, when to update or delete them, and what to check before migrated journeys reach real subscribers.
6 min read
Manage Timed Email Series
Sequences are timed email series. They are useful for onboarding, nurture campaigns, customer education, follow-up flows, and other journeys where subscribers receive multiple emails over time.
Use the sequences API for migration, external content review, internal campaign tooling, or setup scripts that prepare a workspace before users start running campaigns.
Sequence definitions can affect subscriber journeys for days or weeks. Keep names, descriptions, steps, and timing understandable for the people who will review or operate them in Mailrith.
- List existing sequences to avoid importing duplicates.
- Create the sequence definition with a clear name and purpose.
- Add or update email steps in the order you want subscribers to receive them, then ask a Mailrith user to review the order in the sequence editor.
- Confirm delays, sending windows, and filters match the source system or planned journey.
- Ask a user to test every step in Sequences before enrolling real subscribers.
- Keep migration notes that map the source-system sequence to the Mailrith sequence ID.
- List sequences when auditing or syncing existing lifecycle content.
- Create sequences when importing journeys from another platform.
- Update sequences when an external source of truth changes content or timing.
- Delete sequences only after confirming no active workflow still depends on the definition.
Endpoint Overview
GET /v1/sequences lists sequence definitions. Item endpoints let integrations inspect, update, or delete one sequence.
POST /v1/sequences creates a sequence definition. The payload describes the series, including email steps, timing, and content-related settings supported by the OpenAPI schema.
Use the generated reference for exact field names. Do not copy internal app state from the browser because the public API is the stable contract.
/v1/sequences List sequences
Returns sequences available in the authenticated workspace.
View Schema /v1/sequences Create a sequence
Creates a sequence in the authenticated workspace.
View Schema /v1/sequences/{sequence_id} Get a sequence
Returns a sequence in the authenticated workspace.
View Schema /v1/sequences/{sequence_id} Update a sequence
Updates an existing sequence in place.
View Schema /v1/sequences/{sequence_id} Delete a sequence
Deletes an existing sequence from the authenticated workspace.
View SchemaMigration Notes
When migrating from another platform, first recreate the sequence structure as drafts or inactive definitions if your workflow supports review before launch. Then compare the Mailrith version against the source system before activating anything for real subscribers.
Pay special attention to timing. A one-day delay, send window, or missing stop condition can change the subscriber experience even when the email copy looks correct.
- Map source emails to Mailrith sequence steps in order.
- Confirm delay values and time units.
- Check personalization variables in every email body.
- In Mailrith, open the sequence, click each step's
Email Settings, and send test emails before enrolling real subscribers. - Document which source sequence created the Mailrith sequence so future cleanup is easier.
Need Help Shipping an Integration?
Reach the Mailrith team if you need help planning a sync, validating a webhook flow, or troubleshooting a request.
Related Guides
Manage reusable email templates, structured editor content, and approved layout libraries.
Manage automation definitions with triggers, branches, actions, conditions, and review safeguards.
Browse generated endpoint details and download the exact OpenAPI contract for tooling.