Skip to main content
This reference lists every endpoint of the Brudcast platform API: contacts, campaigns, templates, sending domains, sender identities, mailboxes, messages, webhooks and analytics. The details behind each topic below are in the Developers section.

​
Base URL

All requests use HTTPS and JSON. The version is part of the path, and v1 is the only version. See Versioning. The email send API is a separate service with its own base URL. It isn’t listed here. See Email send API.

​
Authentication

Create keys in Developers > API Keys. See Authentication.

​
Scopes

Each key carries scopes, a read and a write scope per group: messages, contacts, campaigns, templates, analytics, webhooks, domains, senders and mailboxes. GET requests need the read scope. Every other method needs the write scope. Each endpoint’s description names the scope it requires. A missing scope returns 403 with code E_INSUFFICIENT_SCOPE. See API keys.

​
Responses

Successful responses carry success, message, data and, on lists, meta:
Most lists take page and limit (up to 100). The message log, webhook deliveries and campaign reports use a cursor instead. meta carries more pagination fields than shown here. See Response format.

​
Errors

Errors carry success: false, a message and usually a code:
Validation failures return 422 with an errors array. Rate limits return 429 with retryAfter in seconds. See Errors and Rate limits.

Quickstart

Make your first call and send your first email.

Authentication

API keys, sending keys and SMTP users.

Response format

The envelope, pagination and filters.

Errors

Status codes and error codes.