The Breaker API lets your own code work with a newsletter: campaigns, contacts, segments and reports.
Read the reference
- API reference. Every endpoint with its parameters, request bodies and responses, at docs.breaker.email.
- OpenAPI file. The same reference as an OpenAPI YAML file. Download it to generate a client, import it into Postman or Insomnia, or hand it to an AI assistant.
Authentication
Every request carries an API key. Create one under Settings, Integrations, API Keys. A key belongs to one newsletter and can be revoked at any time. See API keys.
What the API covers
- Campaigns. Create and update drafts, read and replace the content, and render a preview.
- Contacts. Create, find, update and tag contacts, and change their subscription status.
- Segments. Create static and dynamic segments, read and replace rules, and list members.
- Reports. Opens, clicks, RealClick™ and unsubscribes, for one campaign or a date range.
An API key cannot send a campaign or delete contacts. Drafts created through the API open in the campaign editor, where a person reviews and publishes them.
Other ways to connect