Quick Start
The BetterMail API makes it easy to integrate messaging into your applications. This guide walks you through the essentials so you can send your first email quickly.
Create Account
Create ↗ a free BetterMail account and log in to your dashboard.
Generate API Key
Generate an API Key in the Development Centre ↗.
Make sure to copy and securely store your API key as it will only be shown once at the time of generation. For security reasons, BetterMail does not store your API keys and cannot retrieve them later.
Test API Key
Test your API Key ↗ using the interactive tool in our API Reference ↗.
Be sure to enter your API Key into the Bearer Token field before clicking Send. The API Key needs to be loaded in for each API request.
On success, the API responds with HTTP 200 OK and pong in the response body.
Awesome - your API key is valid and the server is responding. Now you’re ready to send your first email.
Create Campaign
Create a Transactional ↗ campaign and launch it. Note the created Campaign Slug and use it as campaign reference in your API calls.
For example, we’ve set a ORDER_CONFIRMED slug for our Order confirmation campaign, as shown in the screenshot below:
Send Email
You're now ready to send your first email via the API.
