Quick Start
1. Create an API Key
- Log in to Benchmark Email as an account owner.
- Go to Settings > API Keys.
- Click Create API Key.
- Give it a name (e.g., “My Integration”) and select the permissions you need.
- Copy the key immediately — it will only be shown once.
2. Make Your First Request
401 or 403 error, see the errors guide for troubleshooting.
API Reference
| Document | Description |
|---|---|
| Authentication | How to authenticate requests, scopes, and account requirements |
| Rate Limits | Hourly rate limits, monthly quotas, and response headers |
| Errors | Error response format, status codes, and common error scenarios |
| API Reference | Browse the full OpenAPI specification |
Available Resources
| Resource | Scopes | What You Can Do |
|---|---|---|
| Contacts | contacts:read, contacts:write | Create, read, update, delete contacts; manage lists; update custom fields; search and export contacts |
| Campaigns | campaigns:read, campaigns:write | Create, read, update, delete, and duplicate email campaigns; browse templates |
| Reports | reports:read | View dashboard summaries and email performance reports |
| Domains | domains:read | View email sending domains |