Automations API
The automations resource exposes Mailrith workflow definitions for tools that create or synchronize automations outside the app. This guide explains what automations can affect, how to use the public schema, and what to review before you trust a generated workflow.
Manage Automation Definitions
Automations are rule-based workflows that react to subscriber activity and perform actions. Depending on the definition, automations can apply tags, change subscriber state, start or stop sequences, branch based on conditions, and call external systems.
The automations API exposes the automation control plane for integrations that need to migrate, inspect, create, or synchronize workflow definitions outside the app.
Automation changes can have a large impact because automations may run automatically after a trigger. Treat automation writes as high-impact changes and include review steps in your integration.
- List existing automations before creating or updating workflow definitions.
- Build the automation definition from the public schema, not from internal app state.
- Validate every referenced tag, custom field, sequence, magic link, delivery connection, and webhook URL before sending the request.
- Create or update the automation in an inactive or reviewable state when your workflow supports that state.
- Ask a user to review the canvas in Automations.
- Test with internal subscribers before allowing the automation to process real subscriber activity.
- Require explicit approval before activating AI-generated or externally generated automations.
- List automations to audit existing workflows before a migration or cleanup.
- Create automations from a trusted source definition, not from guessed app state.
- Update automations carefully because small changes to branches or conditions can change which subscribers receive which actions.
- Delete automations only after you confirm that the workflow is no longer needed.
Endpoint Overview
GET /v1/automations lists automation definitions. Item endpoints let your integration inspect, update, or delete one automation.
POST /v1/automations creates an automation definition using the public schema. The schema is intentionally structured so external callers can build definitions without depending on the app's internal React state.
Use the generated API reference for exact trigger, condition, path, and action shapes. Validate definitions before sending them to Mailrith. Then test the resulting workflow in the app before relying on it.
/v1/automations List automations
Returns automations in the authenticated workspace.
View Schema /v1/automations Create an automation
Creates an automation in the authenticated workspace.
View Schema /v1/automations/{automation_id} Get an automation
Returns one automation from the authenticated workspace.
View Schema /v1/automations/{automation_id} Update an automation
Updates an existing automation.
View Schema /v1/automations/{automation_id} Delete an automation
Deletes an automation from the authenticated workspace.
View SchemaAutomation Review Checklist
A valid JSON payload is not enough to make an automation safe. The workflow also must make sense for the subscribers, the triggering event, and the actions the automation performs.
Before activating or relying on an automation created by an integration, review the workflow in Mailrith as a user would see it.
- Confirm that the trigger starts only for the intended subscribers.
- Confirm that every branch condition has a clear business meaning.
- Confirm that every tag, sequence, webhook, or status action points to the intended resource.
- Confirm that the workflow has a safe path for subscribers who do not match optional conditions.
- Keep live-send or destructive actions behind explicit review when automations are generated by AI or external tools.
Need Help Shipping an Integration?
Reach the Mailrith team if you need help planning a sync, validating a webhook flow, or troubleshooting a request.