Docs API Reference

Docs API Reference Overview Setup Environment Variables Polar Integration - Access Tokens & Webhooks Packages Apps Addons Deployment Deploying to Netlify Examples Philosophy Structure

API Reference

Introduction Send Email Send Batch Emails List Emails Retrieve Email Update Email Cancel Email List Email Attachments Get Email Attachment List Received Emails Get Received Email List Received Email Attachments Get Received Email Attachment Create Domain List Domains Get Domain Verify Domain Delete Domain Create Tracking Domain List Tracking Domains Get Tracking Domain Delete Tracking Domain Create Contact List Contacts Get Contact Update Contact Delete Contact Add Contact to Segment List Contact Segments Remove Contact from Segment List Contact Topics Update Contact Topics Create API Key List API Keys Delete API Key Create Webhook List Webhooks Get Webhook Update Webhook Delete Webhook Create Segment List Segments Get Segment Delete Segment Create Topic List Topics Get Topic Update Topic Delete Topic Create Contact Property List Contact Properties Get Contact Property Update Contact Property Delete Contact Property Create Broadcast List Broadcasts Get Broadcast Update Broadcast Delete Broadcast Send Broadcast Create Template List Templates Get Template Update Template Delete Template Publish Template Duplicate Template

Auto-generated (v2)

List API keys Create an API key Delete an API key Add a contact to a segment Remove a contact from a segment List contacts Create a contact Get a contact Update a contact Delete a contact List segments for a contact List topics for a contact Update topic subscriptions for a contact List properties Create a property Get a property Update a property Delete a property List segments Create a segment Get a segment Update a segment Delete a segment List contacts in a segment List topics Create a topic Get a topic Update a topic Delete a topic List broadcasts Create a broadcast Get a broadcast Update a broadcast Delete a broadcast Send a broadcast List domains Create a domain Get a domain Update a domain Delete a domain Verify a domain Cancel an email Download an email attachment Retrieve an email attachment Retrieve Email Update an email List email attachments List emails Send an email Send batch emails Retrieve received email attachment Retrieve received email List received email attachments List received emails Environment info Health check Root endpoint List templates Create a template Get a template Update a template Delete a template Duplicate a template Publish a template List tracking domains Create a tracking domain Get a tracking domain Delete a tracking domain List webhooks Create a webhook Get a webhook Update a webhook Delete a webhook

Guides

Migrate from Resend

Setup

Overview of the setup process for Postflare.

Setup

Setting up Postflare is a simple process. Follow the steps outlined in this guide to get started quickly.

Overview

What is Postflare and how do I get started?

Environment Variables

Overview of the environment variables for Postflare.

On this page