# Resend API (unofficial showcase)

> Resend API (unofficial showcase) API documentation

## Api-keys
- [GET /api-keys](https://octri-b2xwp4xdfpqs.octri.dev/get-api-keys): List API keys
- [POST /api-keys](https://octri-b2xwp4xdfpqs.octri.dev/post-api-keys): Create an API key
- [PATCH /api-keys/{api_key_id}](https://octri-b2xwp4xdfpqs.octri.dev/patch-api-keys-api_key_id): Update an API key
- [DELETE /api-keys/{api_key_id}](https://octri-b2xwp4xdfpqs.octri.dev/delete-api-keys-api_key_id): Delete an API key

## Audiences
- [GET /audiences](https://octri-b2xwp4xdfpqs.octri.dev/get-audiences): List audiences
- [POST /audiences](https://octri-b2xwp4xdfpqs.octri.dev/post-audiences): Create an audience
- [GET /audiences/{id}](https://octri-b2xwp4xdfpqs.octri.dev/get-audiences-id): Get an audience
- [DELETE /audiences/{id}](https://octri-b2xwp4xdfpqs.octri.dev/delete-audiences-id): Delete an audience

## Automations
- [GET /automations](https://octri-b2xwp4xdfpqs.octri.dev/get-automations): List automations
- [POST /automations](https://octri-b2xwp4xdfpqs.octri.dev/post-automations): Create an automation
- [GET /automations/{automation_id}](https://octri-b2xwp4xdfpqs.octri.dev/get-automations-automation_id): Retrieve an automation
- [PATCH /automations/{automation_id}](https://octri-b2xwp4xdfpqs.octri.dev/patch-automations-automation_id): Update an automation
- [DELETE /automations/{automation_id}](https://octri-b2xwp4xdfpqs.octri.dev/delete-automations-automation_id): Delete an automation
- [POST /automations/{automation_id}/duplicate](https://octri-b2xwp4xdfpqs.octri.dev/post-automations-automation_id-duplicate): Duplicate an automation
- [GET /automations/{automation_id}/runs](https://octri-b2xwp4xdfpqs.octri.dev/get-automations-automation_id-runs): List automation runs
- [GET /automations/{automation_id}/runs/{run_id}](https://octri-b2xwp4xdfpqs.octri.dev/get-automations-automation_id-runs-run_id): Retrieve an automation run
- [POST /automations/{automation_id}/stop](https://octri-b2xwp4xdfpqs.octri.dev/post-automations-automation_id-stop): Stop an automation

## Broadcasts
- [GET /broadcasts](https://octri-b2xwp4xdfpqs.octri.dev/get-broadcasts): List broadcasts
- [POST /broadcasts](https://octri-b2xwp4xdfpqs.octri.dev/post-broadcasts): Create a broadcast
- [GET /broadcasts/{id}](https://octri-b2xwp4xdfpqs.octri.dev/get-broadcasts-id): Get a broadcast
- [PATCH /broadcasts/{id}](https://octri-b2xwp4xdfpqs.octri.dev/patch-broadcasts-id): Update a broadcast
- [DELETE /broadcasts/{id}](https://octri-b2xwp4xdfpqs.octri.dev/delete-broadcasts-id): Delete a draft broadcast
- [POST /broadcasts/{id}/cancel](https://octri-b2xwp4xdfpqs.octri.dev/post-broadcasts-id-cancel): Cancel a broadcast
- [GET /broadcasts/{id}/clicked-links](https://octri-b2xwp4xdfpqs.octri.dev/get-broadcasts-id-clicked-links): List clicked links for a broadcast
- [POST /broadcasts/{id}/duplicate](https://octri-b2xwp4xdfpqs.octri.dev/post-broadcasts-id-duplicate): Duplicate a broadcast
- [GET /broadcasts/{id}/recipients](https://octri-b2xwp4xdfpqs.octri.dev/get-broadcasts-id-recipients): List recipients of a broadcast
- [POST /broadcasts/{id}/send](https://octri-b2xwp4xdfpqs.octri.dev/post-broadcasts-id-send): Send or schedule a broadcast

## Contact-properties
- [GET /contact-properties](https://octri-b2xwp4xdfpqs.octri.dev/get-contact-properties): List contact properties
- [POST /contact-properties](https://octri-b2xwp4xdfpqs.octri.dev/post-contact-properties): Create a contact property
- [GET /contact-properties/{id}](https://octri-b2xwp4xdfpqs.octri.dev/get-contact-properties-id): Get a contact property
- [PATCH /contact-properties/{id}](https://octri-b2xwp4xdfpqs.octri.dev/patch-contact-properties-id): Update a contact property
- [DELETE /contact-properties/{id}](https://octri-b2xwp4xdfpqs.octri.dev/delete-contact-properties-id): Delete a contact property

## Contacts
- [GET /contacts](https://octri-b2xwp4xdfpqs.octri.dev/get-contacts): List contacts
- [POST /contacts](https://octri-b2xwp4xdfpqs.octri.dev/post-contacts): Create a contact
- [GET /contacts/{contact_id}/segments](https://octri-b2xwp4xdfpqs.octri.dev/get-contacts-contact_id-segments): List segments for a contact
- [POST /contacts/{contact_id}/segments/{segment_id}](https://octri-b2xwp4xdfpqs.octri.dev/post-contacts-contact_id-segments-segment_id): Add a contact to a segment
- [DELETE /contacts/{contact_id}/segments/{segment_id}](https://octri-b2xwp4xdfpqs.octri.dev/delete-contacts-contact_id-segments-segment_id): Remove a contact from a segment
- [GET /contacts/{contact_id}/topics](https://octri-b2xwp4xdfpqs.octri.dev/get-contacts-contact_id-topics): List topics for a contact
- [PATCH /contacts/{contact_id}/topics](https://octri-b2xwp4xdfpqs.octri.dev/patch-contacts-contact_id-topics): Update a contact’s topic subscriptions
- [GET /contacts/{id}](https://octri-b2xwp4xdfpqs.octri.dev/get-contacts-id): Get a contact by ID or email
- [PATCH /contacts/{id}](https://octri-b2xwp4xdfpqs.octri.dev/patch-contacts-id): Update a contact
- [DELETE /contacts/{id}](https://octri-b2xwp4xdfpqs.octri.dev/delete-contacts-id): Delete a contact
- [GET /contacts/imports](https://octri-b2xwp4xdfpqs.octri.dev/get-contacts-imports): List contact imports
- [POST /contacts/imports](https://octri-b2xwp4xdfpqs.octri.dev/post-contacts-imports): Create a contact import
- [GET /contacts/imports/{id}](https://octri-b2xwp4xdfpqs.octri.dev/get-contacts-imports-id): Get a contact import

## Domains
- [GET /domains](https://octri-b2xwp4xdfpqs.octri.dev/get-domains): List domains
- [POST /domains](https://octri-b2xwp4xdfpqs.octri.dev/post-domains): Create a domain
- [GET /domains/{domain_id}](https://octri-b2xwp4xdfpqs.octri.dev/get-domains-domain_id): Get a domain
- [PATCH /domains/{domain_id}](https://octri-b2xwp4xdfpqs.octri.dev/patch-domains-domain_id): Update a domain
- [DELETE /domains/{domain_id}](https://octri-b2xwp4xdfpqs.octri.dev/delete-domains-domain_id): Delete a domain
- [GET /domains/{domain_id}/claim](https://octri-b2xwp4xdfpqs.octri.dev/get-domains-domain_id-claim): Retrieve a domain claim
- [POST /domains/{domain_id}/claim/verify](https://octri-b2xwp4xdfpqs.octri.dev/post-domains-domain_id-claim-verify): Verify a domain claim
- [POST /domains/{domain_id}/verify](https://octri-b2xwp4xdfpqs.octri.dev/post-domains-domain_id-verify): Verify a domain
- [POST /domains/claim](https://octri-b2xwp4xdfpqs.octri.dev/post-domains-claim): Claim a domain

## Emails
- [GET /emails](https://octri-b2xwp4xdfpqs.octri.dev/get-emails): List emails
- [POST /emails](https://octri-b2xwp4xdfpqs.octri.dev/post-emails): Send an email
- [GET /emails/{email_id}](https://octri-b2xwp4xdfpqs.octri.dev/get-emails-email_id): Get an email
- [PATCH /emails/{email_id}](https://octri-b2xwp4xdfpqs.octri.dev/patch-emails-email_id): Update an email schedule
- [GET /emails/{email_id}/attachments](https://octri-b2xwp4xdfpqs.octri.dev/get-emails-email_id-attachments): List attachments for an email
- [GET /emails/{email_id}/attachments/{attachment_id}](https://octri-b2xwp4xdfpqs.octri.dev/get-emails-email_id-attachments-attachment_id): Get an email attachment
- [POST /emails/{email_id}/cancel](https://octri-b2xwp4xdfpqs.octri.dev/post-emails-email_id-cancel): Cancel a scheduled email
- [POST /emails/{email_id}/share](https://octri-b2xwp4xdfpqs.octri.dev/post-emails-email_id-share): Create a shareable email link
- [POST /emails/batch](https://octri-b2xwp4xdfpqs.octri.dev/post-emails-batch): Send a batch of emails
- [GET /emails/metrics](https://octri-b2xwp4xdfpqs.octri.dev/get-emails-metrics): Get account-level email metrics
- [GET /emails/receiving](https://octri-b2xwp4xdfpqs.octri.dev/get-emails-receiving): List received emails
- [GET /emails/receiving/{email_id}](https://octri-b2xwp4xdfpqs.octri.dev/get-emails-receiving-email_id): Get a received email
- [GET /emails/receiving/{email_id}/attachments](https://octri-b2xwp4xdfpqs.octri.dev/get-emails-receiving-email_id-attachments): List attachments for a received email
- [GET /emails/receiving/{email_id}/attachments/{attachment_id}](https://octri-b2xwp4xdfpqs.octri.dev/get-emails-receiving-email_id-attachments-attachment_id): Get an attachment for a received email

## Events
- [GET /events](https://octri-b2xwp4xdfpqs.octri.dev/get-events): List events
- [POST /events](https://octri-b2xwp4xdfpqs.octri.dev/post-events): Create an event
- [GET /events/{identifier}](https://octri-b2xwp4xdfpqs.octri.dev/get-events-identifier): Get an event
- [PATCH /events/{identifier}](https://octri-b2xwp4xdfpqs.octri.dev/patch-events-identifier): Update an event
- [DELETE /events/{identifier}](https://octri-b2xwp4xdfpqs.octri.dev/delete-events-identifier): Delete an event
- [POST /events/send](https://octri-b2xwp4xdfpqs.octri.dev/post-events-send): Send an event

## Inboxes
- [GET /inboxes](https://octri-b2xwp4xdfpqs.octri.dev/get-inboxes): List inboxes
- [POST /inboxes](https://octri-b2xwp4xdfpqs.octri.dev/post-inboxes): Create an inbox
- [GET /inboxes/{inbox_id}](https://octri-b2xwp4xdfpqs.octri.dev/get-inboxes-inbox_id): Get an inbox by ID or email address
- [PATCH /inboxes/{inbox_id}](https://octri-b2xwp4xdfpqs.octri.dev/patch-inboxes-inbox_id): Update an inbox
- [DELETE /inboxes/{inbox_id}](https://octri-b2xwp4xdfpqs.octri.dev/delete-inboxes-inbox_id): Delete an inbox
- [GET /inboxes/{inbox_id}/agent](https://octri-b2xwp4xdfpqs.octri.dev/get-inboxes-inbox_id-agent): Get inbox agent settings
- [PATCH /inboxes/{inbox_id}/agent](https://octri-b2xwp4xdfpqs.octri.dev/patch-inboxes-inbox_id-agent): Update inbox agent settings
- [GET /inboxes/{inbox_id}/drafts](https://octri-b2xwp4xdfpqs.octri.dev/get-inboxes-inbox_id-drafts): List drafts in an inbox
- [POST /inboxes/{inbox_id}/drafts](https://octri-b2xwp4xdfpqs.octri.dev/post-inboxes-inbox_id-drafts): Create an inbox draft
- [GET /inboxes/{inbox_id}/drafts/{draft_id}](https://octri-b2xwp4xdfpqs.octri.dev/get-inboxes-inbox_id-drafts-draft_id): Retrieve an inbox draft
- [PATCH /inboxes/{inbox_id}/drafts/{draft_id}](https://octri-b2xwp4xdfpqs.octri.dev/patch-inboxes-inbox_id-drafts-draft_id): Update an inbox draft
- [DELETE /inboxes/{inbox_id}/drafts/{draft_id}](https://octri-b2xwp4xdfpqs.octri.dev/delete-inboxes-inbox_id-drafts-draft_id): Remove an inbox draft
- [POST /inboxes/{inbox_id}/drafts/{draft_id}/send](https://octri-b2xwp4xdfpqs.octri.dev/post-inboxes-inbox_id-drafts-draft_id-send): Send an inbox draft
- [GET /inboxes/{inbox_id}/labels](https://octri-b2xwp4xdfpqs.octri.dev/get-inboxes-inbox_id-labels): List labels on an inbox
- [POST /inboxes/{inbox_id}/labels](https://octri-b2xwp4xdfpqs.octri.dev/post-inboxes-inbox_id-labels): Create a label on an inbox
- [PATCH /inboxes/{inbox_id}/labels/{label_id}](https://octri-b2xwp4xdfpqs.octri.dev/patch-inboxes-inbox_id-labels-label_id): Update an inbox label
- [DELETE /inboxes/{inbox_id}/labels/{label_id}](https://octri-b2xwp4xdfpqs.octri.dev/delete-inboxes-inbox_id-labels-label_id): Remove a label from an inbox
- [GET /inboxes/{inbox_id}/threads](https://octri-b2xwp4xdfpqs.octri.dev/get-inboxes-inbox_id-threads): List threads in an inbox
- [GET /inboxes/{inbox_id}/threads/{thread_id}](https://octri-b2xwp4xdfpqs.octri.dev/get-inboxes-inbox_id-threads-thread_id): Get an inbox thread
- [PATCH /inboxes/{inbox_id}/threads/{thread_id}](https://octri-b2xwp4xdfpqs.octri.dev/patch-inboxes-inbox_id-threads-thread_id): Update an inbox thread
- [DELETE /inboxes/{inbox_id}/threads/{thread_id}](https://octri-b2xwp4xdfpqs.octri.dev/delete-inboxes-inbox_id-threads-thread_id): Move an inbox thread to trash
- [GET /inboxes/{inbox_id}/threads/{thread_id}/emails](https://octri-b2xwp4xdfpqs.octri.dev/get-inboxes-inbox_id-threads-thread_id-emails): List emails in a thread
- [GET /inboxes/{inbox_id}/threads/{thread_id}/emails/{email_id}](https://octri-b2xwp4xdfpqs.octri.dev/get-inboxes-inbox_id-threads-thread_id-emails-email_id): Retrieve an email from a thread
- [POST /inboxes/{inbox_id}/threads/{thread_id}/emails/{email_id}/forward](https://octri-b2xwp4xdfpqs.octri.dev/post-inboxes-inbox_id-threads-thread_id-emails-email_id-forward): Forward an email from a thread
- [POST /inboxes/{inbox_id}/threads/{thread_id}/emails/{email_id}/reply](https://octri-b2xwp4xdfpqs.octri.dev/post-inboxes-inbox_id-threads-thread_id-emails-email_id-reply): Reply to an email in a thread
- [GET /inboxes/{inbox_id}/threads/search](https://octri-b2xwp4xdfpqs.octri.dev/get-inboxes-inbox_id-threads-search): Search inbox threads

## Logs
- [GET /logs](https://octri-b2xwp4xdfpqs.octri.dev/get-logs): List logs
- [GET /logs/{log_id}](https://octri-b2xwp4xdfpqs.octri.dev/get-logs-log_id): Retrieve a log record

## Oauth
- [GET /oauth/grants](https://octri-b2xwp4xdfpqs.octri.dev/get-oauth-grants): List OAuth grants
- [DELETE /oauth/grants/{oauth_grant_id}](https://octri-b2xwp4xdfpqs.octri.dev/delete-oauth-grants-oauth_grant_id): Revoke an OAuth grant

## Segments
- [GET /segments](https://octri-b2xwp4xdfpqs.octri.dev/get-segments): List segments
- [POST /segments](https://octri-b2xwp4xdfpqs.octri.dev/post-segments): Create a segment
- [GET /segments/{id}](https://octri-b2xwp4xdfpqs.octri.dev/get-segments-id): Get a segment
- [PATCH /segments/{id}](https://octri-b2xwp4xdfpqs.octri.dev/patch-segments-id): Update a segment
- [DELETE /segments/{id}](https://octri-b2xwp4xdfpqs.octri.dev/delete-segments-id): Delete a segment
- [GET /segments/{id}/contacts](https://octri-b2xwp4xdfpqs.octri.dev/get-segments-id-contacts): List contacts in a segment

## Suppressions
- [GET /suppressions](https://octri-b2xwp4xdfpqs.octri.dev/get-suppressions): List suppressions
- [POST /suppressions](https://octri-b2xwp4xdfpqs.octri.dev/post-suppressions): Add an email suppression
- [GET /suppressions/{suppression}](https://octri-b2xwp4xdfpqs.octri.dev/get-suppressions-suppression): Get a suppression by ID or email
- [DELETE /suppressions/{suppression}](https://octri-b2xwp4xdfpqs.octri.dev/delete-suppressions-suppression): Delete a suppression by ID or email
- [POST /suppressions/batch/add](https://octri-b2xwp4xdfpqs.octri.dev/post-suppressions-batch-add): Add up to 100 email suppressions
- [POST /suppressions/batch/remove](https://octri-b2xwp4xdfpqs.octri.dev/post-suppressions-batch-remove): Remove up to 100 suppressions

## Templates
- [GET /templates](https://octri-b2xwp4xdfpqs.octri.dev/get-templates): List templates
- [POST /templates](https://octri-b2xwp4xdfpqs.octri.dev/post-templates): Create a template
- [GET /templates/{id}](https://octri-b2xwp4xdfpqs.octri.dev/get-templates-id): Get a template
- [PATCH /templates/{id}](https://octri-b2xwp4xdfpqs.octri.dev/patch-templates-id): Update a template
- [DELETE /templates/{id}](https://octri-b2xwp4xdfpqs.octri.dev/delete-templates-id): Delete a template
- [POST /templates/{id}/duplicate](https://octri-b2xwp4xdfpqs.octri.dev/post-templates-id-duplicate): Duplicate a template
- [POST /templates/{id}/publish](https://octri-b2xwp4xdfpqs.octri.dev/post-templates-id-publish): Publish a template

## Topics
- [GET /topics](https://octri-b2xwp4xdfpqs.octri.dev/get-topics): List topics
- [POST /topics](https://octri-b2xwp4xdfpqs.octri.dev/post-topics): Create a topic
- [GET /topics/{id}](https://octri-b2xwp4xdfpqs.octri.dev/get-topics-id): Get a topic
- [PATCH /topics/{id}](https://octri-b2xwp4xdfpqs.octri.dev/patch-topics-id): Update a topic
- [DELETE /topics/{id}](https://octri-b2xwp4xdfpqs.octri.dev/delete-topics-id): Delete a topic

## Usage
- [GET /usage](https://octri-b2xwp4xdfpqs.octri.dev/get-usage): Get account usage

## Webhooks
- [GET /webhooks](https://octri-b2xwp4xdfpqs.octri.dev/get-webhooks): List webhooks
- [POST /webhooks](https://octri-b2xwp4xdfpqs.octri.dev/post-webhooks): Create a webhook
- [GET /webhooks/{webhook_id}](https://octri-b2xwp4xdfpqs.octri.dev/get-webhooks-webhook_id): Get a webhook
- [PATCH /webhooks/{webhook_id}](https://octri-b2xwp4xdfpqs.octri.dev/patch-webhooks-webhook_id): Update a webhook
- [DELETE /webhooks/{webhook_id}](https://octri-b2xwp4xdfpqs.octri.dev/delete-webhooks-webhook_id): Delete a webhook
- [GET /webhooks/{webhook_id}/events](https://octri-b2xwp4xdfpqs.octri.dev/get-webhooks-webhook_id-events): List events for a webhook
- [GET /webhooks/{webhook_id}/events/{event_id}](https://octri-b2xwp4xdfpqs.octri.dev/get-webhooks-webhook_id-events-event_id): Get a webhook event
- [GET /webhooks/{webhook_id}/events/{event_id}/attempts](https://octri-b2xwp4xdfpqs.octri.dev/get-webhooks-webhook_id-events-event_id-attempts): List attempts for a webhook event
- [POST /webhooks/{webhook_id}/events/{event_id}/replay](https://octri-b2xwp4xdfpqs.octri.dev/post-webhooks-webhook_id-events-event_id-replay): Replay a webhook event
- [POST /webhooks/{webhook_id}/signing-secret/rotate](https://octri-b2xwp4xdfpqs.octri.dev/post-webhooks-webhook_id-signing-secret-rotate): Rotate a webhook signing secret

## Optional
- [Changelog](https://octri-b2xwp4xdfpqs.octri.dev/changelog): API version history and breaking changes