Mailrith Developers
Developer Docs
Everything for Mailrith's public API: quickstarts, platform rules, resource guides, and the generated `v1` reference.
Search results
Matching Articles
Getting Started
Quickstart
Create a workspace key and make your first authenticated request to Mailrith's public API.
Getting Started
Authentication
Use workspace-scoped Bearer keys and learn how Mailrith authorizes protected requests.
Getting Started
Testing the API
Run the local worker, generate a workspace key, call the endpoints, and run automated integration coverage.
Getting Started
Agents
Discover Mailrith from agent runtimes with llms files, API metadata, OpenAPI, and authenticated capability discovery.
Getting Started
SDKs
Use the official TypeScript and Python SDKs generated from Mailrith's public contract.
Getting Started
MCP Server
Connect Mailrith to agent runtimes through the official remote MCP server and streamable HTTP transport.
Getting Started
Zapier
Build, test, and publish the official Mailrith Zapier Platform CLI integration.
API Concepts
Pagination
Page through large list endpoints safely with cursors, saved progress, and reusable sync loops.
API Concepts
Errors
Read Mailrith error envelopes, map status codes to behavior, and decide when retrying a request is safe.
API Concepts
Idempotency
Retry import and export job creation safely with the `Idempotency-Key` header.
API Concepts
Versioning
Pin clients to the `/v1` path contract and plan future upgrades with the OpenAPI document.
API Concepts
Consent And Privacy API Boundaries
Understand which Subscriber privacy fields the public API accepts and when to use Mailrith-hosted consent workflows instead.
API Resources
Subscribers API
List and upsert subscribers with practical guidance for identity, tags, fields, syncs, and imports.
API Resources
Tags API
Use tags as clear labels on subscriber records for targeting, forms, imports, and automation conditions.
API Resources
Custom Fields API
Manage typed subscriber fields before you sync field values, forms, segments, or migrated subscriber data.
API Resources
Forms API
Manage Mailrith capture forms from external form builders, migrations, and admin tools.
API Resources
Landing Pages API
Manage Mailrith-hosted landing pages, page definitions, settings, and public URLs.
API Resources
Broadcasts API
Create campaign drafts, send test emails, and require deliberate approval before live broadcast sends.
API Resources
Email Templates API
Manage reusable email templates, structured editor content, and approved layout libraries.
API Resources
Sequences API
Manage timed email series for onboarding, nurture, migration, and lifecycle workflows.
API Resources
Automations API
Manage automation definitions with triggers, branches, actions, conditions, and review safeguards.
API Resources
Magic Links API
Create and maintain email links that perform clear subscriber actions when clicked.
API Resources
Segments API
Manage saved subscriber rules and preview unsaved segment definitions before saving or sending.
API Resources
Import and Export Jobs
Create async subscriber import and export jobs, use idempotency, and monitor job status until completion.
API Resources
Webhook Subscriptions API
Create signed event subscriptions for CRMs, dashboards, audits, and workflow systems.
API Reference
API Reference
Browse generated endpoint details and download the exact OpenAPI contract for tooling.
No Matching Developer Docs
Try a different keyword such as a resource name, request pattern, or platform rule like "pagination" or "jobs".