Sequences API
The sequences resource lets external systems prepare, migrate, or synchronize time-based email series. This guide explains how to plan sequence definitions, when to update or delete sequences, and what to check before migrated journeys reach real subscribers.
Manage Timed Email Series
Sequences are timed email series. Use them for onboarding, nurture programs, customer education, follow-up flows, and other journeys where Subscribers receive multiple emails over time.
Use the Sequences API for migration, external content preparation, internal lifecycle tooling, or setup scripts that prepare a workspace before users activate Sequences.
Sequence definitions can affect subscriber journeys for days or weeks. Use clear names, descriptions, steps, and timing so the people who review or operate the sequences in Mailrith can understand them.
- List existing sequences before creating new ones so you do not import duplicates.
- Create the sequence definition with a clear name and purpose.
- Add or update email steps in the order that subscribers should receive them. Then ask a Mailrith user to review the step order in the sequence editor.
- Confirm that 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 you audit or sync existing lifecycle content.
- Create sequences when you import journeys from another platform.
- Update sequences when an external source of truth changes content or timing.
- Delete sequences only after you confirm that no active workflow still depends on the sequence 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 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 one sequence from the authenticated workspace.
View Schema /v1/sequences/{sequence_id} Update a sequence
Updates an existing paused Sequence. Before changing a running Sequence, read it by ID, retain its status in the current task only, pause it, apply the update, and use bounded direct item reads until is_updating is false. Run preflight, return it to running only if it was running before and preflight passes, and verify the final status. If the update fails before changing the Sequence, restore its prior running status when preflight passes. If readiness or the prior status cannot be restored, leave it paused and immediately report the failure; never activate a Sequence that was not already running.
View Schema /v1/sequences/{sequence_id} Delete a sequence
Deletes an existing sequence from the authenticated workspace.
View Schema /v1/sequences/{sequence_id}/journey-preview Preview a sequence journey
Returns the bounded saved email timeline and shows which messages a selected Subscriber is eligible to receive, without enrolling the Subscriber or sending email.
View Schema /v1/sequences/{sequence_id}/preflight Check sequence readiness
Checks the saved Sequence, its published emails, and its sender without changing data or sending email.
View Schema /v1/sequences/{sequence_id}/status Activate or pause a sequence
Starts or pauses one Sequence without changing its content or delivery settings.
View Schema /v1/sequences/{sequence_id}/test Send sequence test messages
Sends up to five selected saved Sequence emails to one explicit test address. This does not enroll a Subscriber, start the Sequence, or write delivery activity.
View SchemaMigration Notes
When you migrate 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 with the source-system version before activating the sequence 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 is correct.
- Map source emails to Mailrith sequence steps in order.
- Confirm that delay values and time units are correct.
- 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.