Reference
API Reference
Error codes, rate limits, and changelog for the Synapse API. Use these references when debugging integration issues or planning for scale.
Base URL
https://synapse-api.pyrx.tech/v1All API routes are versioned under /v1/. No breaking changes within a version.
Error response format
All error responses follow a consistent structure:
{
"detail": "Human-readable error message",
"code": "machine_readable_code"
}Plan limit errors include additional context:
{
"message": "monthly_events limit reached (10000/10000)",
"code": "plan_limit_reached",
"limit_type": "monthly_events",
"current": 10000,
"maximum": 10000,
"plan": "starter"
}HTTP status codes
| Status | Meaning |
|---|---|
| 200 | Success |
| 201 | Resource created |
| 202 | Accepted for async processing (events, triggers) |
| 400 | Bad request (invalid parameters or state) |
| 401 | Missing or invalid authentication |
| 403 | Insufficient permissions or plan limit reached |
| 404 | Resource not found |
| 422 | Validation error (request body doesn't match schema) |
| 500 | Internal server error |
Plan limits
Five limits are enforced at the service layer. Exceeding a limit returns 403 with code plan_limit_reached.
| Limit | Free | Starter | Growth |
|---|---|---|---|
| Monthly emails | 1,000 | 10,000 | 100,000 |
| Contacts | 1,000 | 10,000 | 100,000 |
| Monthly events | 10,000 | 100,000 | 1,000,000 |
| Team members | 1 | 3 | 10 |
| Data retention | 30 days | 90 days | 365 days |
Clone endpoints
Clone resources between test and live environments. All clone endpoints accept a target_environment body parameter ("test" or "live") and use upsert behavior — matching resources in the target are updated, new ones are created.
| Method | Endpoint | Also clones |
|---|---|---|
POST | /v1/templates/{slug}/clone | All template versions |
POST | /v1/flows/{flow_id}/clone | Versions + conversion goals |
POST | /v1/segments/{segment_id}/clone | - |
POST | /v1/contacts/views/{view_id}/clone | - |
POST | /v1/reports/{report_id}/clone | Report schedules (inactive) |
See the Clone guide for request/response examples and the recommended clone workflow.
Detailed references
Error Codes
Complete list of error codes, HTTP status mappings, and machine-readable error responses.
Rate Limits
Per-plan rate limits for event ingestion, API calls, and email sending. Includes retry strategies.
Changelog
API versioning history, breaking changes, deprecation notices, and migration guides.