# SendPost Docs

- [Introduction](https://docs.sendpost.io/index.md): Welcome to SendPost API Documentation.
- [SendGrid Integration](https://docs.sendpost.io/guides/sendgrid/overview.md): Connect your SendGrid account to SendPost for unified email management, advanced analytics, and enhanced deliverability monitoring.
- [Setting Up SendGrid Integration](https://docs.sendpost.io/guides/sendgrid/setup.md): Configure SendGrid as a Third-Party Sending Provider in SendPost with automatic webhook setup.
- [Sending Emails via SendGrid](https://docs.sendpost.io/guides/sendgrid/sending-emails.md): Send emails through SendGrid using the SendPost API with IP Pool routing.
- [SendGrid-Compatible API](https://docs.sendpost.io/guides/sendgrid/compatible-api.md): Migrate from SendGrid with minimal code changes using SendPost's SendGrid-Compatible API.
- [SendGrid Event Types](https://docs.sendpost.io/guides/sendgrid/event-types.md): Understand SendGrid event types and how they map to SendPost for tracking email delivery and engagement.
- [Tracking & Analytics](https://docs.sendpost.io/guides/sendgrid/analytics.md): Track opens, clicks, bounces and configure rate limiting for SendGrid emails in SendPost.
- [Troubleshooting & FAQs](https://docs.sendpost.io/guides/sendgrid/troubleshooting.md): Common issues, solutions, and frequently asked questions for SendGrid integration with SendPost.
- [Custom SMTP Integration](https://docs.sendpost.io/guides/custom-smtp/overview.md): Connect your own SMTP server (Postfix or any standards-compliant MTA) to SendPost for unified analytics, routing, and throttling.
- [Setting Up Custom SMTP Integration](https://docs.sendpost.io/guides/custom-smtp/setup.md): Configure your own SMTP server as a Third-Party Sending Provider in SendPost with connectivity validation and event reporting.
- [Sending Emails via Custom SMTP](https://docs.sendpost.io/guides/custom-smtp/sending-emails.md): Send emails through your own SMTP server using the SendPost API with IP Pool routing.
- [Event Reporting Agent](https://docs.sendpost.io/guides/custom-smtp/event-agent.md): Install and configure the SendPost event reporting agent to report delivered, bounced, and deferred events from your MTA logs.
- [Custom SMTP Event Types](https://docs.sendpost.io/guides/custom-smtp/event-types.md): Understand Custom SMTP (CS) event types and how they map to the sending lifecycle.
- [Tracking & Analytics](https://docs.sendpost.io/guides/custom-smtp/analytics.md): Track opens, clicks, bounces, and configure rate limiting for Custom SMTP emails in SendPost.
- [Troubleshooting & FAQs](https://docs.sendpost.io/guides/custom-smtp/troubleshooting.md): Common issues, solutions, and frequently asked questions for Custom SMTP integration with SendPost.
- [SparkPost Integration](https://docs.sendpost.io/guides/sparkpost/overview.md): Connect your SparkPost account to SendPost for unified email management, advanced analytics, and enhanced deliverability monitoring.
- [Setting Up SparkPost Integration](https://docs.sendpost.io/guides/sparkpost/setup.md): Configure SparkPost as a Third-Party Sending Provider in SendPost with automatic webhook setup.
- [Sending Emails via SparkPost](https://docs.sendpost.io/guides/sparkpost/sending-emails.md): Send emails through SparkPost using the SendPost API with IP Pool routing.
- [SparkPost Event Types](https://docs.sendpost.io/guides/sparkpost/event-types.md): Understand SparkPost event types, bounce classifications, and how they map to SendPost.
- [Tracking & Analytics](https://docs.sendpost.io/guides/sparkpost/analytics.md): Track opens, clicks, bounces and configure rate limiting for SparkPost emails in SendPost.
- [Troubleshooting & FAQs](https://docs.sendpost.io/guides/sparkpost/troubleshooting.md): Common issues, solutions, and frequently asked questions for SparkPost integration with SendPost.
- [Amazon SES Integration](https://docs.sendpost.io/guides/amazon-ses/overview.md): Connect your Amazon SES account to SendPost for unified email management, advanced analytics, and enhanced deliverability monitoring.
- [Setting Up Amazon SES Integration](https://docs.sendpost.io/guides/amazon-ses/setup.md): Configure Amazon SES as a Third-Party Sending Provider in SendPost with automatic identity and configuration set setup.
- [Sending Emails via Amazon SES](https://docs.sendpost.io/guides/amazon-ses/sending-emails.md): Send emails through Amazon SES using the SendPost API with automatic IP Pool routing.
- [Amazon SES Compatible API](https://docs.sendpost.io/guides/amazon-ses/compatible-api.md): Migrate from Amazon SES with minimal code changes using SendPost's Amazon SES Compatible API.
- [Amazon SES Event Types](https://docs.sendpost.io/guides/amazon-ses/event-types.md): Understand Amazon SES event types and how they map to SendPost for tracking email delivery and engagement.
- [Tracking & Analytics](https://docs.sendpost.io/guides/amazon-ses/analytics.md): Track opens, clicks, bounces and configure rate limiting for Amazon SES emails in SendPost.
- [Troubleshooting & FAQs](https://docs.sendpost.io/guides/amazon-ses/troubleshooting.md): Common issues, solutions, and frequently asked questions for Amazon SES integration with SendPost.
- [Mailgun Integration](https://docs.sendpost.io/guides/mailgun/overview.md): Connect your Mailgun account to SendPost for unified email management, advanced analytics, and enhanced deliverability monitoring.
- [Setting Up Mailgun Integration](https://docs.sendpost.io/guides/mailgun/setup.md): Configure Mailgun as a Third-Party Sending Provider in SendPost with automatic webhook setup.
- [Sending Emails via Mailgun](https://docs.sendpost.io/guides/mailgun/sending-emails.md): Send emails through Mailgun using the SendPost API with IP Pool routing.
- [Mailgun Event Types](https://docs.sendpost.io/guides/mailgun/event-types.md): Understand Mailgun event types and how they map to SendPost for tracking email delivery and engagement.
- [Tracking & Analytics](https://docs.sendpost.io/guides/mailgun/analytics.md): Track opens, clicks, bounces and configure rate limiting for Mailgun emails in SendPost.
- [Troubleshooting & FAQs](https://docs.sendpost.io/guides/mailgun/troubleshooting.md): Common issues, solutions, and frequently asked questions for Mailgun integration with SendPost.
- [Postmark Integration](https://docs.sendpost.io/guides/postmark/overview.md): Connect your Postmark account to SendPost for unified email management, template-based sending, and event tracking via Message Streams.
- [Setting Up Postmark Integration](https://docs.sendpost.io/guides/postmark/setup.md): Configure Postmark as a Third-Party Sending Provider in SendPost with Server API Token and Message Stream selection.
- [Sending Emails via Postmark](https://docs.sendpost.io/guides/postmark/sending-emails.md): Send template-based emails through Postmark using the SendPost API with IP Pool routing and Postmark templates.
- [Postmark Event Types](https://docs.sendpost.io/guides/postmark/event-types.md): Understand Postmark event types and how they map to SendPost for tracking email delivery and engagement.
- [Tracking & Analytics](https://docs.sendpost.io/guides/postmark/analytics.md): Track opens, clicks, bounces, and configure rate limiting for Postmark emails in SendPost.
- [Troubleshooting & FAQs](https://docs.sendpost.io/guides/postmark/troubleshooting.md): Common issues, solutions, and frequently asked questions for Postmark integration with SendPost.
- [Next.js Quickstart](https://docs.sendpost.io/quickstart/nextjs.md): Learn how to send emails with SendPost in your Next.js application using API routes, Server Actions, and React components
- [Express.js Quickstart](https://docs.sendpost.io/quickstart/express.md): Learn how to send emails with SendPost in your Express.js application with route handlers, middleware, and error handling
- [React Quickstart](https://docs.sendpost.io/quickstart/react.md): Learn how to send emails with SendPost in your React application using hooks, forms, and API integration
- [Nuxt.js Quickstart](https://docs.sendpost.io/quickstart/nuxt.md): Learn how to send emails with SendPost in your Nuxt.js application using server routes, server utilities, and composables
- [NestJS Quickstart](https://docs.sendpost.io/quickstart/nestjs.md): Learn how to send emails with SendPost in your NestJS application using modules, services, and dependency injection
- [JavaScript SDK Quickstart](https://docs.sendpost.io/quickstart/javascript-sdk.md): Learn how to configure and send your first email with SendPost JavaScript SDK
- [AWS Lambda Quickstart](https://docs.sendpost.io/quickstart/aws-lambda.md): Learn how to send emails with SendPost in AWS Lambda functions using Node.js, Python, and other runtimes
- [Vercel Functions Quickstart](https://docs.sendpost.io/quickstart/vercel-functions.md): Learn how to send emails with SendPost in Vercel Serverless Functions using API routes and edge functions
- [Supabase Edge Functions Quickstart](https://docs.sendpost.io/quickstart/supabase-edge-functions.md): Learn how to send emails with SendPost in Supabase Edge Functions using Deno runtime
- [Netlify Functions Quickstart](https://docs.sendpost.io/quickstart/netlify-functions.md): Learn how to send emails with SendPost in Netlify Serverless Functions using JavaScript and TypeScript
- [Cloudflare Workers Quickstart](https://docs.sendpost.io/quickstart/cloudflare-workers.md): Learn how to send emails with SendPost in Cloudflare Workers using the Fetch API
- [Django Quickstart](https://docs.sendpost.io/quickstart/django.md): Learn how to send emails with SendPost in your Django application using custom email backend, views, and signals
- [Flask Quickstart](https://docs.sendpost.io/quickstart/flask.md): Learn how to send emails with SendPost in your Flask application using blueprints, utilities, and error handling
- [FastAPI Quickstart](https://docs.sendpost.io/quickstart/fastapi.md): Learn how to send emails with SendPost in your FastAPI application using async endpoints, dependency injection, and Pydantic models
- [Python SDK Quickstart](https://docs.sendpost.io/quickstart/python-sdk.md): Learn how to configure and send your first email with SendPost Python SDK
- [Laravel Quickstart](https://docs.sendpost.io/quickstart/laravel.md): Learn how to send emails with SendPost in your Laravel application using Mailables, Notifications, and custom mail drivers
- [PHP SDK Quickstart](https://docs.sendpost.io/quickstart/php-sdk.md): Learn how to configure and send your first email with SendPost PHP SDK
- [Ruby on Rails Quickstart](https://docs.sendpost.io/quickstart/ruby-on-rails.md): Learn how to send emails with SendPost in your Ruby on Rails application using ActionMailer, mailers, and background jobs
- [Ruby SDK Quickstart](https://docs.sendpost.io/quickstart/ruby-sdk.md): Learn how to configure and send your first email with SendPost Ruby SDK
- [Spring Boot Quickstart](https://docs.sendpost.io/quickstart/spring-boot.md): Learn how to send emails with SendPost in your Spring Boot application using services, REST controllers, and dependency injection
- [Java SDK Quickstart](https://docs.sendpost.io/quickstart/java-sdk.md): Learn how to configure and send your first email with SendPost Java SDK
- [Golang SDK Quickstart](https://docs.sendpost.io/quickstart/golang-sdk.md): Learn how to configure and send your first email with SendPost Golang SDK
- [Personalize Emails](https://docs.sendpost.io/api-reference/common-use-cases/personalisation-within-emails.md): Use Handlebars templating to personalize email content in the subject, HTML body, and text body with custom field variables.
- [Custom Headers](https://docs.sendpost.io/api-reference/common-use-cases/custom-headers.md): Pass custom key-value pairs in email requests to track campaigns, customers, and events. Headers are included in all webhook events for easy reconciliation.
- [Unsubscribe Links](https://docs.sendpost.io/api-reference/common-use-cases/adding-unsubscribe-links.md): Add unsubscribe links to emails using the built-in {{unsubscribe}} template variable. Recipients who click the link are automatically added to your suppression list.
- [Email Classification](https://docs.sendpost.io/api-reference/common-use-cases/using-groups-for-email-classification.md): Categorize and tag emails with groups to organize, filter, and analyze performance. Separate transactional from promotional emails, track campaigns, or analyze by product line.
- [Managing Senders](https://docs.sendpost.io/api-reference/common-use-cases/controlling-sender-name-and-email.md): Set the sender name and email address that appears in recipient inboxes using the from field.
- [Multi-Tenant Applications](https://docs.sendpost.io/api-reference/common-use-cases/multi-tenant.md): Build multi-tenant email applications by creating sub-accounts for each tenant, managing domains and IPPools, and using custom headers for event reconciliation via webhooks.
- [Introduction](https://docs.sendpost.io/api-reference/introduction.md): Understand the basics of SendPost REST convention and common parameters
- [API Versioning & Migration](https://docs.sendpost.io/api-reference/api-versioning.md): How the SendPost response contract is versioned, how to migrate from the legacy shape to v1, and the deprecation timeline.
- [Changelog](https://docs.sendpost.io/api-reference/changelog.md): Notable changes to the SendPost public REST API, including the full field-level diff of the v1 response contract.
- [Send Email](https://docs.sendpost.io/api-reference/email/send-email.md): Send transactional or marketing emails to one or multiple recipients. This is the primary endpoint for all email sending through SendPost.
- [Send Email With Template](https://docs.sendpost.io/api-reference/email/send-email-with-template.md): Send emails using pre-configured templates stored in SendPost. Templates separate email content from code, enabling:
- [Get Domain](https://docs.sendpost.io/api-reference/domain/get-a-specific-domain.md): Retrieve detailed information about a specific sending domain, including DNS record configuration and verification status.
- [Delete Domain](https://docs.sendpost.io/api-reference/domain/delete-a-specific-domain.md): Remove a sending domain from your sub-account. Once deleted, you can no longer send emails from addresses on this domain.
- [List Domains](https://docs.sendpost.io/api-reference/domain/get-all-domains.md): Retrieve all sending domains configured for this sub-account. Use this endpoint to audit your domain setup, check verification status, or retrieve DNS records for configuration.
- [Create Domain](https://docs.sendpost.io/api-reference/domain/create-a-new-domain.md): Register a new sending domain with SendPost. After creation, you'll receive DNS records that must be configured with your DNS provider before you can send emails.
- [List Stats](https://docs.sendpost.io/api-reference/stats/get-all-stats.md): Retrieve daily email statistics for a specific sub-account. Returns one record per day within the date range, perfect for charting trends and identifying patterns.
- [Get Aggregate Stats](https://docs.sendpost.io/api-reference/stats/get-aggregate-stats.md): Retrieve summarized email statistics for a sub-account over a date range. Unlike daily stats, this returns a single record with totals across all days—ideal for high-level reporting.
- [Get Group Aggregate Stats](https://docs.sendpost.io/api-reference/stats/get-aggregated-stats-by-group.md): Retrieve aggregated email statistics filtered by a specific group/tag. Groups are labels you assign when sending emails to categorize and segment your analytics.
- [List Suppressions](https://docs.sendpost.io/api-reference/suppression/get-all-suppressions.md): Retrieve the suppression list for your sub-account. Suppressions are email addresses that should not receive emails to protect your sender reputation and ensure compliance.
- [Create Suppressions](https://docs.sendpost.io/api-reference/suppression/create-new-suppressions.md): Add email addresses to your suppression list to prevent future emails from being sent. This is essential for maintaining sender reputation and compliance.
- [Delete Suppressions](https://docs.sendpost.io/api-reference/suppression/delete-suppressions.md): Remove email addresses from your suppression list, allowing them to receive emails again.
- [List IPs](https://docs.sendpost.io/api-reference/ip/get-all-ips.md): Retrieve all IP addresses allocated to your account. IPs are the foundation of your sending infrastructure and directly impact deliverability.
- [Get IP](https://docs.sendpost.io/api-reference/ip/get-a-specific-ip.md): Retrieve detailed information about a specific IP address, including its warmup status, type, and configuration.
- [Update IP](https://docs.sendpost.io/api-reference/ip/update-an-existing-ip.md): Modify settings for an existing IP address. Use this to manage warmup configuration.
- [Delete IP](https://docs.sendpost.io/api-reference/ip/delete-a-specific-ip.md): Remove an IP address from your account. This action is irreversible.
- [Allocate IP](https://docs.sendpost.io/api-reference/ip/allocate-a-new-ip.md): Request allocation of a new dedicated IP address to your account. New IPs start in warmup state to build sender reputation gradually.
- [Get Message](https://docs.sendpost.io/api-reference/message/retrieve-a-specific-message.md): Retrieve complete details about a specific email message, including full event timeline and metadata.
- [Routing Strategies and Metadata](https://docs.sendpost.io/api-reference/ippools/routing.md): Description of your new file.
- [List IPPools](https://docs.sendpost.io/api-reference/ippools/get-all-ippools.md): Retrieve all IP pools configured for your account. IP pools group IPs and third-party sending providers (TPSPs) for intelligent traffic routing.
- [Create IPPool](https://docs.sendpost.io/api-reference/ippools/create-a-new-ippool.md): Create a new IP pool to organize your sending infrastructure. Pools group IPs and third-party sending providers (TPSPs) for intelligent routing.
- [Get IPPool](https://docs.sendpost.io/api-reference/ippools/get-a-specific-ippool.md): Retrieve complete details about a specific IP pool, including all IPs and TPSPs assigned to it.
- [Update IPPool](https://docs.sendpost.io/api-reference/ippools/update-an-existing-ippool.md): Modify an existing IP pool's configuration, including name, IPs, TPSPs, and routing strategy.
- [Delete IPPool](https://docs.sendpost.io/api-reference/ippools/delete-a-specific-ippool.md): Remove an IP pool from your account. This action is irreversible.
- [List Account Stats](https://docs.sendpost.io/api-reference/stats-a/get-all-account-stats.md): Retrieve daily email statistics aggregated across all sub-accounts. Returns one record per day within the date range—ideal for organization-wide reporting.
- [Get Account Aggregate Stats](https://docs.sendpost.io/api-reference/stats-a/get-account-aggregate-stats.md): Retrieve summarized email statistics across all sub-accounts for a date range. Returns a single aggregated record—perfect for high-level reporting and dashboards.
- [List Account Group Stats](https://docs.sendpost.io/api-reference/stats-a/get-all-account-stats-by-group.md): Retrieve daily email statistics for a specific group across all sub-accounts. Returns one record per day, filtered by the group/tag you specify.
- [Get Account Group Aggregate Stats](https://docs.sendpost.io/api-reference/stats-a/get-account-aggregate-stats-by-group.md): Retrieve summarized email statistics for a specific group across all sub-accounts. Returns a single aggregated record for the group—ideal for campaign reporting.
- [List Sub-Accounts](https://docs.sendpost.io/api-reference/sub-account/get-all-sub-accounts.md): Retrieve all sub-accounts under your main account. Sub-accounts allow you to segment email sending for different applications, brands, or use cases.
- [Create Sub-Account](https://docs.sendpost.io/api-reference/sub-account/create-a-new-sub-account.md): Create a new sub-account to segment your email sending. Each sub-account gets its own API key, suppression list, and statistics.
- [Get Sub-Account](https://docs.sendpost.io/api-reference/sub-account/get-a-specific-sub-account.md): Retrieve detailed information about a specific sub-account, including API keys, SMTP credentials, and configuration.
- [Update Sub-Account](https://docs.sendpost.io/api-reference/sub-account/update-an-existing-sub-account.md): Modify settings for an existing sub-account. Use this to rename sub-accounts, update labels, or modify configuration.
- [Delete Sub-Account](https://docs.sendpost.io/api-reference/sub-account/delete-a-specific-sub-account.md): Remove a sub-account from your organization. This action is irreversible.
- [Webhook Reference](https://docs.sendpost.io/api-reference/webhook/webhook-testing.md)
- [Understanding Webhook Event Lifecycle](https://docs.sendpost.io/api-reference/webhook/understanding-webhook-event-lifecycle.md): Learn about the complete email lifecycle and what each webhook event type means. Understand the difference between Processed and Sent events, and how delivery outcomes are determined.
- [Webhook Signature Verification](https://docs.sendpost.io/api-reference/webhook/webhook-signature-verification.md)
- [List Webhooks](https://docs.sendpost.io/api-reference/webhook/get-all-webhooks.md): Retrieve all configured webhooks for your account. Webhooks enable real-time notifications when email events occur, allowing you to build reactive applications.
- [Create Webhook](https://docs.sendpost.io/api-reference/webhook/create-a-new-webhook.md): Create a new webhook to receive real-time notifications for email events. Your endpoint will receive HTTP POST requests with event data as they occur.
- [Get Webhook](https://docs.sendpost.io/api-reference/webhook/get-a-specific-webhook.md): Retrieve detailed information about a specific webhook, including its endpoint URL and enabled events.
- [Update Webhook](https://docs.sendpost.io/api-reference/webhook/update-an-existing-webhook.md): Modify an existing webhook's configuration. Use this to change the endpoint URL or update which events trigger notifications.
- [Delete Webhook](https://docs.sendpost.io/api-reference/webhook/delete-a-specific-webhook.md): Remove a webhook from your account. After deletion, no further events will be sent to that endpoint.
- [SendPost Webhook Object](https://docs.sendpost.io/api-reference/webhook/sendpost-webhook-object.md)

## OpenAPI Specs

- [swagger](/swagger.yaml)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.