Loading...

Docs API Reference

Docs API Reference Overview Setup Environment Variables Polar Integration - Access Tokens & Webhooks Packages Apps Addons Deployment Examples 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 Cancel 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 Update an API key Delete an API key Add a contact to a segment Remove a contact from a segment Create a contact List contacts Create a contact Get a contact Update a contact Delete 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 automations Create an automation Get an automation Update an automation Delete an automation Get an automation run List an automation's runs Stop an automation Cancel a broadcast List broadcasts Create a broadcast Get a broadcast Update a broadcast Delete a broadcast List broadcast clicked links List broadcast recipients Send a broadcast Create a capture key Get a captured email List captured emails 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 Get email metrics List email attachments List emails Send an email Send batch emails Share an email Retrieve received email attachment Retrieve received email List received email attachments List received emails List events Create an event Get an event Update an event Delete an event Send an event Environment info Health check Root endpoint Get a log List logs List suppressions Add a suppression Add suppressions in bulk Remove suppressions in bulk Get a suppression Remove a suppression 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 Verify a tracking domain List webhooks Create a webhook Get a webhook Update a webhook Delete a webhook Get a webhook event List a webhook event's attempts List webhook events Replay a webhook event Rotate a webhook's signing secret

Guides

Quota and sending limits Migrate from Resend

List segments

List all segments for the organization.

Delete a property

Delete a property by ID.

Create a segment

Create a new segment for the organization.