Changelog
The API is at version 1.0.0, served under /v1. The tenant template is at version 1.
How we version
Section titled “How we version”- The API. Within
v1we only add: new endpoints, new optional request fields, new response fields, new error codes on existing statuses and new event types. Ignore fields you don’t know. A change that could break a working integration gets a new major version, served side by side withv1. - Events. New event types and new
detailfields can appear. Match ondetail-typeand ignore fields you don’t know. - The template. We support the current template version and the one before it. See Updating the template.
The API reference and the OpenAPI document always describe the version that’s running.
The first release of the v1 API and template version 1.
- Contacts, consent records, tags, custom fields, engagement scores, lookup by email, batches of up to 1,000, unsubscribe, resubscribe and erasure.
- Segments on tags, fields and engagement, with counts. Each condition and nested group says what it is in
type. - Liquid templates with required unsubscribe links and footers, previews and test sends.
- Campaigns in stages with the
warmup,standardandsingleplans or your own, automatic pauses on bounce and complaint rates, resume and cancel. - Reports by stage and by link, and every recipient’s send record.
- Imports from Mailchimp (API key or OAuth) and CSV, with dry runs; exports of contacts, send records, events and one contact’s data.
- Setup:
/health, verify, custom tracking and API domains, settings and API keys. - Events on your EventBridge bus for unsubscribes, bounces, complaints, campaign stages, pauses and completions, and imports.
- The developer console and the
rhino-relayCLI. - An OpenAPI document ready for generating client libraries: client names, retry policies, pagination and waiters on every operation.
- Service in
us-east-2; you can register in any Region where SES sends email, and it starts once we run there (Regions and limits).