API Reference

The API lets your developers manage subscribers, trigger transactional and broadcast sends, and pull reporting data programmatically. This page summarizes the main resource groups; the complete, always-current specification is published as an OpenAPI (Swagger) document you can browse interactively or import into tools like Postman. (Confirm the exact URL for the interactive reference in your account.)

Every request is authenticated with an API key or token sent in an authorization header, scoped to your account. Base URLs, key names, and rate limits are account-specific, so treat the values below as placeholders and read the exact figures from the live reference.

Reference

Resource group	Typical methods	What it does	Example path
Subscribers	GET, POST, PATCH, DELETE	Create, look up, and update subscribers and their custom fields	/v1/subscribers/{id}
Suppression	GET, POST, DELETE	Add or remove addresses from the account-wide suppression list	/v1/suppressions
Transactional send	POST	Send a single, triggered message to one subscriber	/v1/messages
Broadcasts	GET, POST	Schedule or trigger an Edition as a Broadcast	/v1/broadcasts/{id}/send
Reports	GET	Retrieve opens, clicks, delivery, and other metrics	/v1/reports/{broadcastId}
Folders	GET	List Project Folders and the Editions within them	/v1/folders

Notes

• Formats. Requests and responses use JSON; timestamps are ISO 8601 (UTC). Send a Content-Type: application/json header on write requests.
• Paging. List endpoints are paged. Follow the paging cursor or next link in each response rather than assuming a fixed page size.
• Errors. Standard HTTP status codes apply — 4xx for client issues (auth, validation), 5xx for server-side faults. Error bodies include a machine-readable code and a human-readable message.
• Versioning & rate limits. The version prefix (e.g. /v1) and per-key rate limits are account-specific. Handle 429 responses with backoff. (Confirm the exact limits in your account.)
• Source of truth. When this summary and the OpenAPI document disagree, trust the OpenAPI document — it is generated directly from the running service.

Related

• Send a transactional email
• Manage the suppression list
• Personalization tags
• Metrics dictionary

---

Canonical terms: Author, Edition, Folder (Project Folder), Broadcast. See the Glossary.