API Reference
The Synapse REST API. All endpoints are versioned under /v1/ and require API key authentication.
Base URL
https://synapse-api.pyrx.tech/v1Events API
Ingest single and batch events with schema validation.
Contacts API
CRUD operations for contacts and contact properties.
Direct Send API
Send transactional emails directly without a flow.
Templates API
Create, update, and render NLT email templates.
Template Modules API
Manage reusable template modules and blocks.
Flows API
Create and manage automated email flows.
Segments API
Build and evaluate audience segments.
Campaigns API
Create, schedule, and send email campaigns.
Analytics API
Query delivery metrics, engagement stats, and funnel data.
Reports API
Generate and export custom reports.
Domains API
Manage sender domains and DNS verification.
Workspace API
Workspace settings, members, and billing.
Jobs API
Track async job progress for bulk operations.
Webhook Endpoints API
Register and manage outbound webhook subscriptions.
Error Codes
Complete list of error codes and their meanings.
Rate Limits
Rate limiting policy and per-endpoint limits.