Base URLs
- /v1 (primary compatibility base)
- /resend/v1 (secondary alias)
Resend-Compatible API Reference
Private compatibility layer for your own infrastructure. This is not an official Resend service or copy of proprietary docs.
Auth
Send Authorization: Bearer <API_KEY> or x-api-key.
Guides
Api Keys
Audiences
-
POST
Create Audience
Compatibility endpoint to create audience data.
/audiences implemented -
GET
List Audiences
Compatibility endpoint to list audiences data.
/audiences implemented -
DELETE
Delete Audience
Compatibility endpoint to delete audience data.
/audiences/{id} implemented -
GET
Retrieve Audience
Compatibility endpoint to retrieve audience data.
/audiences/{id} implemented
Broadcasts
-
POST
Create Broadcast
Compatibility endpoint to create broadcast data.
/broadcasts implemented -
GET
List Broadcasts
Compatibility endpoint to list broadcasts data.
/broadcasts implemented -
DELETE
Delete Broadcast
Compatibility endpoint to delete broadcast data.
/broadcasts/{id} implemented -
GET
Retrieve Broadcast
Compatibility endpoint to retrieve broadcast data.
/broadcasts/{id} implemented -
GET
List Broadcast Jobs
List background jobs created for a broadcast.
/broadcasts/{id}/jobs implemented -
PATCH
Update Broadcast
Compatibility endpoint to update broadcast data.
/broadcasts/{id} implemented -
POST
Send Broadcast
Queue a broadcast campaign for background fanout.
/broadcasts/{id}/send implemented -
POST
Cancel Broadcast
Cancel the active broadcast campaign job.
/broadcasts/{id}/cancel implemented
Contact Properties
-
POST
Create Contact Property
Compatibility endpoint to create contact property data.
/contact-properties implemented -
GET
List Contact Properties
Compatibility endpoint to list contact properties data.
/contact-properties implemented -
GET
Retrieve Contact Property
Compatibility endpoint to retrieve contact property data.
/contact-properties/{id} implemented -
PATCH
Update Contact Property
Compatibility endpoint to update contact property data.
/contact-properties/{id} implemented -
DELETE
Delete Contact Property
Compatibility endpoint to delete contact property data.
/contact-properties/{id} implemented
Contacts
-
POST
Create Contact
Compatibility endpoint to create contact data.
/contacts implemented -
POST
Upsert Contacts Batch
Create or update multiple contacts keyed by external IDs.
/contacts/upsert-batch implemented -
GET
List Contacts
Compatibility endpoint to list contacts data.
/contacts implemented -
GET
Retrieve Contact
Compatibility endpoint to retrieve contact data.
/contacts/{id} implemented -
PATCH
Update Contact
Compatibility endpoint to update contact data.
/contacts/{id} implemented -
DELETE
Delete Contact
Compatibility endpoint to delete contact data.
/contacts/{id} implemented -
GET
List Contact Segments
List segment memberships for one contact.
/contacts/{contact_id}/segments implemented -
POST
Add Contact to Segment
Attach a contact to a segment.
/contacts/{contact_id}/segments/{segment_id} implemented -
DELETE
Delete Contact Segment
Remove a contact from a segment.
/contacts/{contact_id}/segments/{segment_id} implemented -
GET
Retrieve Contact Topics
Get topic subscription state for one contact.
/contacts/{contact_id}/topics implemented -
PATCH
Update Contact Topics
Update topic subscription state for one contact.
/contacts/{contact_id}/topics implemented
Domains
-
POST
Create Domain
Compatibility endpoint to create domain data.
/domains implemented -
GET
List Domains
Compatibility endpoint to list domains data.
/domains implemented -
GET
Retrieve Domain
Compatibility endpoint to retrieve domain data.
/domains/{domain_id} implemented -
PATCH
Update Domain
Compatibility endpoint to update domain data.
/domains/{domain_id} implemented -
DELETE
Delete Domain
Compatibility endpoint to delete domain data.
/domains/{domain_id} implemented -
POST
Verify Domain
Run DNS verification checks for a configured sending domain.
/domains/{domain_id}/verify implemented
Emails
-
POST
Send Email
Send a single transactional email.
/emails implemented -
GET
List Sent Emails
List recently sent emails in reverse chronological order.
/emails implemented -
GET
Retrieve Email
Get delivery state and metadata for one sent email.
/emails/{email_id} implemented -
PATCH
Update Email
Update mutable email content while still queued.
/emails/{email_id} implemented -
POST
Cancel Email
Cancel pending delivery attempts for a queued email.
/emails/{email_id}/cancel implemented -
POST
Send Batch Emails
Send multiple emails in one request.
/emails/batch implemented -
GET
List Attachments
List attachments available for a sent email.
/emails/{email_id}/attachments implemented -
GET
Retrieve Attachment
Download a specific attachment for a sent email.
/emails/{email_id}/attachments/{attachment_id} implemented -
GET
List Received Emails
List inbound emails captured by the receiving worker.
/emails/receiving implemented -
GET
Retrieve Received Email
Get one inbound email mapped from the ticket mailbox.
/emails/receiving/{email_id} implemented -
GET
List Attachments
List attachments available for a received email.
/emails/receiving/{email_id}/attachments implemented -
GET
Retrieve Attachment
Download a specific attachment for a received email.
/emails/receiving/{email_id}/attachments/{attachment_id} implemented
Segments
-
POST
Create Segment
Compatibility endpoint to create segment data.
/segments implemented -
GET
List Segments
Compatibility endpoint to list segments data.
/segments implemented -
GET
Retrieve Segment
Compatibility endpoint to retrieve segment data.
/segments/{id} implemented -
DELETE
Delete Segment
Compatibility endpoint to delete segment data.
/segments/{id} implemented -
PUT
Replace Segment Members
Replace the membership list for a static segment.
/segments/{id}/members implemented
Templates
-
POST
Create Template
Compatibility endpoint to create template data.
/templates implemented -
GET
List Templates
Compatibility endpoint to list templates data.
/templates implemented -
GET
Retrieve Template
Compatibility endpoint to retrieve template data.
/templates/{id} implemented -
PATCH
Update Template
Compatibility endpoint to update template data.
/templates/{id} implemented -
DELETE
Delete Template
Compatibility endpoint to delete template data.
/templates/{id} implemented -
POST
Publish Template
Mark a template as published for production usage.
/templates/{id}/publish implemented -
POST
Duplicate Template
Create a copy of an existing template.
/templates/{id}/duplicate implemented
Topics
-
POST
Create Topic
Compatibility endpoint to create topic data.
/topics implemented -
GET
List Topics
Compatibility endpoint to list topics data.
/topics implemented -
GET
Retrieve Topic
Compatibility endpoint to retrieve topic data.
/topics/{id} implemented -
PATCH
Update Topic
Compatibility endpoint to update topic data.
/topics/{id} implemented -
DELETE
Delete Topic
Compatibility endpoint to delete topic data.
/topics/{id} implemented
Webhooks
-
POST
Create Webhook
Create a webhook endpoint for delivery and engagement events.
/webhooks implemented -
GET
List Webhooks
List configured webhook endpoints.
/webhooks implemented -
GET
Retrieve Webhook
Retrieve one configured webhook endpoint.
/webhooks/{webhook_id} implemented -
PATCH
Update Webhook
Update a configured webhook endpoint.
/webhooks/{webhook_id} implemented -
DELETE
Delete Webhook
Delete a configured webhook endpoint.
/webhooks/{webhook_id} implemented