Guides

These guides cover the contract every endpoint in the BoostMail API shares. Read them once and you can reason about any call: how to authenticate it, what happens if you send too many, how errors are shaped, how to page through a list, what stability to expect from /v1, and the two rules that keep a send from going out twice or to the wrong person.

The guides

1. Authentication: bearer tokens, the key format, minting keys, scopes, and the difference between a 401 and a 403.
2. Rate limits: the two rate-limit windows, the response headers, and how to handle a 429.
3. Errors: the error envelope, the full status-to-code table, and how to read a 422’s field-level details.
4. Pagination: cursor-based paging with limit, cursor, and next_cursor.
5. Versioning: how /v1 is versioned and what stability to expect going forward.
6. Sending: transactional and campaign sends, idempotency, and how to avoid a double send.
7. Suppression: how suppression differs from marketing consent, and the precedence order BoostMail applies.

New to the API? Start with Get started instead, then come back here for the details.