# Deliveryman AI

- [Introduction](https://docs.deliveryman.ai/v1/introduction.md): The campaign, contact and sequence endpoints of the Deliveryman API
- [List all Workspaces](https://docs.deliveryman.ai/api-reference-v1/workspaces/list-all-workspaces.md): Returns all workspaces belonging to the authenticated user.
- [List all Domains](https://docs.deliveryman.ai/api-reference-v1/domains/list-all-domains.md): Retrieves all domains in this user account. If `workspace_id` query parameter is provided, only fetches domains from that workspace.
- [List all Campaigns](https://docs.deliveryman.ai/api-reference-v1/campaign/list-all-campaigns.md): Retrieves all campaigns in this user account. If `workspace_id` query parameter is provided, only fetches campaigns from that workspace.
- [Retrieve Campaign](https://docs.deliveryman.ai/api-reference-v1/campaign/retrieve-campaign.md): Fetches details for a single campaign.
- [Create new Campaign](https://docs.deliveryman.ai/api-reference-v1/campaign/create-new-campaign.md): Creates a new campaign with provided details. Campaign will be in `created` state until it is started/scheduled using respective apis.
- [Update Campaign](https://docs.deliveryman.ai/api-reference-v1/campaign/update-campaign.md): Updates details for a single campaign. Updates can only be performed on campaigns in `created` state. Use this by first fetching campaign `settings` data using GET request. Update the required values in there and pass that entire object in `update_data`.
- [Change Campaign Contact List](https://docs.deliveryman.ai/api-reference-v1/campaign/change-campaign-contact-list.md): Updates campaign to use a different set of contact lists, replacing the current ones. An address present in more than one list is only contacted once. This request starts a background task and might take a few minutes for changes to be reflected depending on the size of contact list. Campaign will b…
- [Start Campaign](https://docs.deliveryman.ai/api-reference-v1/campaign/start-campaign.md): Starts the given campaign immediately.
- [Scheduled Start](https://docs.deliveryman.ai/api-reference-v1/campaign/scheduled-start.md): Schedules the campaign to start automatically at a given future date.
- [Cancel Scheduled Start](https://docs.deliveryman.ai/api-reference-v1/campaign/cancel-scheduled-start.md): Cancels auto-start schedule which was set for a campaign using `/campaign/schedule` POST request.
- [Pause Campaign](https://docs.deliveryman.ai/api-reference-v1/campaign/pause-campaign.md): Pauses the given running campaign. Paused campaigns can be resumed later using `/campaign/resume` api.
- [Resume Campaign](https://docs.deliveryman.ai/api-reference-v1/campaign/resume-campaign.md): Resumes the given paused campaign.
- [Cancel Campaign](https://docs.deliveryman.ai/api-reference-v1/campaign/cancel-campaign.md): Cancels the given campaign. If campaign is running, this will also stop all future scheduled emails. Existing campaign data will remain as it is. Once cancelled, this campaign cannot be restarted.
- [Email Open Events](https://docs.deliveryman.ai/api-reference-v1/campaign/email-open-events.md): Returns list of email open event data for given campaign.
- [Link Click Events](https://docs.deliveryman.ai/api-reference-v1/campaign/link-click-events.md): Returns list of link click event data for given campaign.
- [List all Email Sequences](https://docs.deliveryman.ai/api-reference-v1/campaign-email-sequence/list-all-email-sequences.md): Returns all the email sequence data for this campaign.
- [Retrieve Email Sequence](https://docs.deliveryman.ai/api-reference-v1/campaign-email-sequence/retrieve-email-sequence.md): Returns details for a given campaign email sequence.
- [Create Email Sequence](https://docs.deliveryman.ai/api-reference-v1/campaign-email-sequence/create-email-sequence.md): Creates a new email sequence for a campaign using given details. This can only be done if the campaign is in `created` state.
- [Update Email Sequence](https://docs.deliveryman.ai/api-reference-v1/campaign-email-sequence/update-email-sequence.md): Updates details for the given campaign email sequence. Updates can only be performed if the campaign is in `created` state. Use existing values for `update_data` by fetching them from `Retrieve Email Sequence` API, and then only update the required fieds.
- [Delete Email Sequence](https://docs.deliveryman.ai/api-reference-v1/campaign-email-sequence/delete-email-sequence.md): Deletes given email sequence from the campaign. Deletion can only be performed if the campaign is in `created` state.
- [List all Contact Lists](https://docs.deliveryman.ai/api-reference-v1/contact-list/list-all-contact-lists.md): Retrieves all contact lists in this user account. If `workspace_id` query parameter is provided, only fetches lists from that workspace.
- [List all Leads](https://docs.deliveryman.ai/api-reference-v1/leads/list-all-leads.md): Retrieves all leads data for the given campaign.
- [Retrieve a Lead](https://docs.deliveryman.ai/api-reference-v1/leads/retrieve-a-lead.md): Returns details for the given Lead.
- [List all Campaign Replies](https://docs.deliveryman.ai/api-reference-v1/replies/list-all-campaign-replies.md): Returns all reply data for the given campaign.
- [Introduction](https://docs.deliveryman.ai/introduction.md): Send email, retrieve email, read replies and get events from your Deliveryman domains
- [Quickstart](https://docs.deliveryman.ai/quickstart.md): Send your first email, check its status and read the reply
- [Webhooks](https://docs.deliveryman.ai/webhooks.md): Get events for your emails as they happen
- [Rate limits](https://docs.deliveryman.ai/rate-limits.md): How many requests you can make and how fast your emails go out
- [List Domains](https://docs.deliveryman.ai/api-reference/domains/list-domains.md): Returns the domains connected to your account.
- [List Domain Emails](https://docs.deliveryman.ai/api-reference/domains/list-domain-emails.md): Returns the email accounts on a connected domain, so you know what to pass as `from` in `Send Email`. Supports pagination with `limit` and `offset`.
- [Send Email](https://docs.deliveryman.ai/api-reference/email/send-email.md): Sends a single email from one of your connected domains and returns its `message_id`.
- [Retrieve Sent Email](https://docs.deliveryman.ai/api-reference/email/retrieve-sent-email.md): Returns a single email sent through the API, with its opens, clicks, bounce, unsubscribe and replies, by its `message_id`. Use this to catch up on an email's activity if a webhook was missed, or to check whether a `scheduled` email has gone out.
- [List Sent Emails](https://docs.deliveryman.ai/api-reference/email/list-sent-emails.md): Returns emails sent through the API, newest first, with their opens, clicks, bounce, unsubscribe and replies.
- [List Replies](https://docs.deliveryman.ai/api-reference/inbox/list-replies.md): Returns conversations that have received replies, most recent reply first. Each item is the email that started the conversation, with every reply in `email.replies`.
- [List Suppressed Emails](https://docs.deliveryman.ai/api-reference/suppression-list/list-suppressed-emails.md): Returns addresses your emails won't be sent to, newest first. `bounces` are addresses whose mail server rejected an email. `unsubscribes` are recipients who opted out or that you added. Without `type`, both are returned. Supports pagination with `limit` and `offset`.
- [Add Suppressed Email](https://docs.deliveryman.ai/api-reference/suppression-list/add-suppressed-email.md): Adds an address to a workspace's suppression list. Emails to it are rejected until it's removed. Adding an address that's already on the list returns the existing entry.
- [Remove Suppressed Email](https://docs.deliveryman.ai/api-reference/suppression-list/remove-suppressed-email.md): Removes an address from your suppression list, from one workspace or from all of them. Addresses that have hard bounced may still be rejected by `Send Email` to protect your domains' reputation.
- [Verify Email](https://docs.deliveryman.ai/api-reference/email-verification/verify-email.md): Checks whether an email address exists and can receive email. The result is returned as is, nothing is stored and sending isn't blocked based on it, so you decide what to do with it.
- [Email sent](https://docs.deliveryman.ai/api-reference/webhook-events/email-sent.md): Sent when the recipient's mail server accepts an email. The email's `status` becomes `delivered`. The server can still bounce the email later, in which case a `bounce` event follows.
- [Email failed](https://docs.deliveryman.ai/api-reference/webhook-events/email-failed.md): Sent when an email that was `scheduled` (returned with status `202` by `Send Email`) can't be sent when its send slot comes, for example because the domain stopped being able to send, credits ran out or the recipient was suppressed in the meantime. The email's `status` becomes `failed` and it isn't…
- [Email opened](https://docs.deliveryman.ai/api-reference/webhook-events/email-opened.md): Sent when the recipient opens an email that has `open_tracking` enabled. Sent for every open, not just the first. Automated opens by mail security scanners are filtered out.
- [Link clicked](https://docs.deliveryman.ai/api-reference/webhook-events/link-clicked.md): Sent when the recipient clicks a link in an email that has `click_tracking` enabled. Automated clicks by mail security scanners are filtered out.
- [Email bounced](https://docs.deliveryman.ai/api-reference/webhook-events/email-bounced.md): Sent when the recipient's mail server rejects an email. The address is added to your suppression list and further emails to it are rejected. Failures caused by the sending side are not reported as bounces.
- [Reply received](https://docs.deliveryman.ai/api-reference/webhook-events/reply-received.md): Sent when a reply arrives in a conversation started with `Send Email`. `data` describes the first email of the conversation, and `data.reply` holds the reply itself.
- [Recipient unsubscribed](https://docs.deliveryman.ai/api-reference/webhook-events/recipient-unsubscribed.md): Sent when the recipient unsubscribes using their mail client's unsubscribe button. The address is added to your suppression list.

## OpenAPI Specs

- [openapi](/api-reference/openapi.json)
- [openapi-v1](/openapi-v1.yml)
- [openapi](/openapi.yml)


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