API Reference
Browse the Samva email API endpoints by service, generated from the OpenAPI specification.
The Samva API is a REST API: requests and responses are JSON, and standard HTTP status codes signal success or failure. Browse endpoints by service in the sidebar, or start from the conventions reference below.
OpenAPI specification: the live spec is published at api.samva.dev/v1/openapi.json. See the OpenAPI page for details.
Conventions
Shared conventions (base URL, authentication, request and response shapes, status codes, errors, and pagination) are documented once in the REST API reference. Start there, then use the per-endpoint pages in the sidebar.
REST conventions
Base URL, headers, status codes, errors, and pagination.
API keys
API keys, headers, and error responses.
TypeScript SDK
The official SDK over this API.
Send an email
A runnable send walkthrough in curl, Python, Go, and PHP.
Endpoints by service
- Messages: send and manage messages
- Email: domains, senders, threading, and inbound
- Templates: reusable, versioned email templates
- Drafts: saved message drafts
- Scheduled messages: one-off scheduled sends
- Campaigns: audience campaigns with scheduled runs
- Attachments: message attachments
- Media: media uploads
Contacts & Conversations
- Contacts: contact management
- Contact groups: segments and audiences
- Conversations: conversation threading
Configuration
- Webhooks: webhook endpoint configuration
- API keys: API key management
- Developers: the log of accepted sends
- Organizations: organization settings
Analytics & Reference
- Analytics: delivery metrics and exports
Support
Need help with the API? Email support@samva.dev.