Environments and base URLs
The platform exposes two environments: a sandbox for building and testing integrations, and production for live traffic to real subscribers. Each has its own base URL, credentials, and data. Point non-production code at the sandbox so test Broadcasts never reach real subscribers, then switch the base URL and API key when you go live.
The exact host names are specific to your account and region, so treat the values below as placeholders and (confirm the exact base URLs and region in your account).
Reference
| Environment | Purpose | Base URL (example) | Credentials | Notes |
|---|---|---|---|---|
| Sandbox | Build and test integrations; safe to send test Editions | https://sandbox-api.{your-account}.example.com/v1 | Sandbox API key | Isolated data; sends may be rate-limited or routed to a test inbox |
| Production | Live sends to real subscribers | https://api.{your-account}.example.com/v1 | Production API key | Real deliverability, suppression, and reporting apply |
Common per-request values you may also need to configure:
| Item | Example | Notes |
|---|---|---|
| API version segment | /v1 | Pinned in the path; avoid relying on an unversioned URL |
| Account or region identifier | {your-account} / {region} | Baked into the host name in most accounts |
| Auth header | Authorization: Bearer {api-key} | Confirm the exact scheme in your account |
| Webhook/callback origin | region-specific IP range or host | Allowlist the environment you subscribe from |
Notes
- Keys are environment-scoped. A sandbox key never works against production and vice versa. Store each key per environment (for example, in separate secrets) rather than hard-coding.
- Data is isolated. Subscribers, Folders, Editions, suppression entries, and reports created in the sandbox do not appear in production.
- Suppression still applies in production. Live sends honor the account-wide suppression list — see Manage the suppression list.
- Use HTTPS only and keep the version segment (for example
/v1) so a future change does not silently alter behavior. - Match webhooks to the environment that produced the event so test traffic and live traffic stay separate.
Related
Canonical terms: Author, Edition, Folder (Project Folder), Broadcast. See the Glossary.