# Create Email Sequence Source: https://docs.deliveryman.ai/api-reference-v1/campaign-email-sequence/create-email-sequence /openapi-v1.yml post /api/v1/email-sequence/ Creates a new email sequence for a campaign using given details. This can only be done if the campaign is in `created` state. The content is checked and given a spam rate score; the result is returned in `label`, `score`, `verdict` and `suggestions`. # Delete Email Sequence Source: https://docs.deliveryman.ai/api-reference-v1/campaign-email-sequence/delete-email-sequence /openapi-v1.yml delete /api/v1/email-sequence/ Deletes given email sequence from the campaign. Deletion can only be performed if the campaign is in `created` state. # List all Email Sequences Source: https://docs.deliveryman.ai/api-reference-v1/campaign-email-sequence/list-all-email-sequences /openapi-v1.yml get /api/v1/email-sequences/ Returns all the email sequence data for this campaign. # Retrieve Email Sequence Source: https://docs.deliveryman.ai/api-reference-v1/campaign-email-sequence/retrieve-email-sequence /openapi-v1.yml get /api/v1/email-sequence/ Returns details for a given campaign email sequence. # Update Email Sequence Source: https://docs.deliveryman.ai/api-reference-v1/campaign-email-sequence/update-email-sequence /openapi-v1.yml patch /api/v1/email-sequence/ 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. # Cancel Campaign Source: https://docs.deliveryman.ai/api-reference-v1/campaign/cancel-campaign /openapi-v1.yml post /api/v1/campaign/cancel/ 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. # Cancel Scheduled Start Source: https://docs.deliveryman.ai/api-reference-v1/campaign/cancel-scheduled-start /openapi-v1.yml delete /api/v1/campaign/schedule/ Cancels the scheduled start of a campaign that is in `scheduled` status, moving it back to `created`. # Change Campaign Contact List Source: https://docs.deliveryman.ai/api-reference-v1/campaign/change-campaign-contact-list /openapi-v1.yml patch /api/v1/campaign/change-contact-list/ 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 be moved to `creating` status until done. Returns status code `202` upon successfully starting the update task. This operation can only be peformed on campaigns in `created` status. # Create new Campaign Source: https://docs.deliveryman.ai/api-reference-v1/campaign/create-new-campaign /openapi-v1.yml post /api/v1/campaign/ Creates a new campaign with provided details. Campaign will be in `created` state until it is started/scheduled using respective apis. # Email Open Events Source: https://docs.deliveryman.ai/api-reference-v1/campaign/email-open-events /openapi-v1.yml get /api/v1/campaign/email-open-events/ Returns email opens recorded for the campaign, newest first. Opens detected as bots are excluded. Supports pagination with `limit` and `offset`. # Link Click Events Source: https://docs.deliveryman.ai/api-reference-v1/campaign/link-click-events /openapi-v1.yml get /api/v1/campaign/link-click-events/ Returns link clicks recorded for the campaign's emails, newest first. Clicks detected as bots are excluded. Supports pagination with `limit` and `offset`. # List all Campaigns Source: https://docs.deliveryman.ai/api-reference-v1/campaign/list-all-campaigns /openapi-v1.yml get /api/v1/campaigns/ Returns the campaigns in your account, newest first. If `workspace_id` is provided, only campaigns from that workspace are returned. Supports pagination with `limit` and `offset`. # Pause Campaign Source: https://docs.deliveryman.ai/api-reference-v1/campaign/pause-campaign /openapi-v1.yml post /api/v1/campaign/pause/ Pauses the given running campaign. Paused campaigns can be resumed later using `/campaign/resume` api. # Resume Campaign Source: https://docs.deliveryman.ai/api-reference-v1/campaign/resume-campaign /openapi-v1.yml post /api/v1/campaign/resume/ Resumes the given paused campaign. Returns `402` if the workspace has no credits left. # Retrieve Campaign Source: https://docs.deliveryman.ai/api-reference-v1/campaign/retrieve-campaign /openapi-v1.yml get /api/v1/campaign/ Returns details for a single campaign. Its `settings` object can be edited and sent back to `Update Campaign`. # Scheduled Start Source: https://docs.deliveryman.ai/api-reference-v1/campaign/scheduled-start /openapi-v1.yml post /api/v1/campaign/schedule/ Schedules the campaign to start automatically at a given future date, at least 5 minutes from now. The same requirements as `Start Campaign` apply. # Start Campaign Source: https://docs.deliveryman.ai/api-reference-v1/campaign/start-campaign /openapi-v1.yml post /api/v1/campaign/start/ Starts the given campaign immediately. The campaign needs contacts, valid email sequences and at least one usable sending domain, and its workspace needs credits (`402` otherwise). A campaign with exactly one email sequence must use the `single-message` scheduling strategy, and a campaign with more than one must use one of the other strategies. # Update Campaign Source: https://docs.deliveryman.ai/api-reference-v1/campaign/update-campaign /openapi-v1.yml patch /api/v1/campaign/ 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`. # Create Contact List Source: https://docs.deliveryman.ai/api-reference-v1/contact-list/create-contact-list /openapi-v1.yml post /api/v1/contact-list/ Creates a contact list from rows of contact data, the same way a CSV upload does in the web app. Send the CSV's header row as `columns` and the remaining rows as `rows`, and use `field_mappings` to choose which columns to import. The import runs in the background and returns `202` straight away with the list in `uploading` status. Poll `Retrieve Contact List` until its status is `active` (or `verifying` while emails are being verified) before using it in a campaign. # Delete Contact List Source: https://docs.deliveryman.ai/api-reference-v1/contact-list/delete-contact-list /openapi-v1.yml delete /api/v1/contact-list/ Permanently deletes a contact list and its contacts. A list can't be deleted while it's used by a campaign that is `created`, `scheduled`, `running` or `paused`. # List all Contact Lists Source: https://docs.deliveryman.ai/api-reference-v1/contact-list/list-all-contact-lists /openapi-v1.yml get /api/v1/contacts/ Retrieves all contact lists in this user account. If `workspace_id` query parameter is provided, only fetches lists from that workspace. # List Contact List Contacts Source: https://docs.deliveryman.ai/api-reference-v1/contact-list/list-contact-list-contacts /openapi-v1.yml get /api/v1/contact-list/contacts/ Returns the contacts in a contact list, in import order. Supports pagination with `limit` and `offset`. # Rename Contact List Source: https://docs.deliveryman.ai/api-reference-v1/contact-list/rename-contact-list /openapi-v1.yml patch /api/v1/contact-list/ Changes the name of a contact list. # Retrieve Contact List Source: https://docs.deliveryman.ai/api-reference-v1/contact-list/retrieve-contact-list /openapi-v1.yml get /api/v1/contact-list/ Returns details for a single contact list, including its import status and column mappings. # Start Contact List Verification Source: https://docs.deliveryman.ai/api-reference-v1/contact-list/start-contact-list-verification /openapi-v1.yml post /api/v1/contact-list/verification/start/ Verifies the email addresses in a contact list that was imported without verification, was only partly verified, or whose previous verification failed. Every contact is verified again. Verification runs in the background; follow it with `email_verification_status` from `Retrieve Contact List`. # Stop Contact List Verification Source: https://docs.deliveryman.ai/api-reference-v1/contact-list/stop-contact-list-verification /openapi-v1.yml post /api/v1/contact-list/verification/stop/ Stops an in-progress email verification. The contact list stays usable, and its verification status becomes `failed`, so verification can be started again later. # Add Domain Source: https://docs.deliveryman.ai/api-reference-v1/domains/add-domain /openapi-v1.yml post /api/v1/domain/ Adds a domain to a workspace and returns the 2 nameservers you need to add as NS records for it at your DNS provider. Connecting a domain takes 3 steps: 1. Add the domain with this request. 2. Add the returned `nameservers` as NS records at your DNS provider, then call `Check Domain Nameservers` until its `state` is `verified`. DNS changes can take a while to propagate. 3. Call `Start Domain Setup` to create the domain's email accounts. Setup runs in the background; `setup_complete` becomes true once it's done and the domain moves into warmup. Returns `403` if the workspace has reached its domain limit. # Check Domain Nameservers Source: https://docs.deliveryman.ai/api-reference-v1/domains/check-domain-nameservers /openapi-v1.yml get /api/v1/domain/nameservers/ Checks whether the domain's NS records point to the nameservers returned by `Add Domain`. Setup can only be started once `state` is `verified`. DNS changes can take a while to propagate, so call this again later if records are missing. # Delete Domain Source: https://docs.deliveryman.ai/api-reference-v1/domains/delete-domain /openapi-v1.yml delete /api/v1/domain/ Starts deleting a domain and its email accounts. Deletion runs in the background and the domain's status is `deleting` until it's done. A domain can't be deleted while a campaign using it is `scheduled`, `running` or `paused`. # List all Domains Source: https://docs.deliveryman.ai/api-reference-v1/domains/list-all-domains /openapi-v1.yml get /api/v1/domains/ Returns the domains connected to your account, newest first. If `workspace_id` is provided, only domains from that workspace are returned. Supports pagination with `limit` and `offset`. # Retrieve Domain Source: https://docs.deliveryman.ai/api-reference-v1/domains/retrieve-domain /openapi-v1.yml get /api/v1/domain/ Returns details for a single domain, including its setup progress and the nameservers that must be added as NS records at your DNS provider. # Start Domain Setup Source: https://docs.deliveryman.ai/api-reference-v1/domains/start-domain-setup /openapi-v1.yml post /api/v1/domain/setup/ Creates the domain's email accounts using the chosen naming strategy and sets up its mail server. The domain's nameservers must be verified first (see `Check Domain Nameservers`), and setup can only be started once per domain. Setup runs in the background and returns `202` straight away. Poll `Retrieve Domain` to follow progress: `setup_complete` becomes true and the status moves to `warmup` when it's done. # List all Leads Source: https://docs.deliveryman.ai/api-reference-v1/leads/list-all-leads /openapi-v1.yml get /api/v1/leads/ Returns the leads in a campaign, ordered by email address, with the emails sent to each lead and any replies and link clicks. Supports pagination with `limit` and `offset`. # Retrieve a Lead Source: https://docs.deliveryman.ai/api-reference-v1/leads/retrieve-a-lead /openapi-v1.yml get /api/v1/lead/ Returns details for the given Lead. # List all Campaign Replies Source: https://docs.deliveryman.ai/api-reference-v1/replies/list-all-campaign-replies /openapi-v1.yml get /api/v1/replies/ Returns all replies received for the given campaign, newest first. Unlike other list endpoints, the response is a plain array and is not paginated. # List all Workspaces Source: https://docs.deliveryman.ai/api-reference-v1/workspaces/list-all-workspaces /openapi-v1.yml get /api/v1/workspaces/ Returns all workspaces in your account. Use a workspace's `id` as `workspace_id` in other requests. This endpoint is not paginated. # Introduction Source: https://docs.deliveryman.ai/v1/introduction The campaign, contact and sequence endpoints of the Deliveryman API Version 1 of the Deliveryman API drives the dashboard's campaign features from your own code: campaigns, contact lists, leads, email sequences and replies. V2 covers sending, replies, verification, suppression and webhooks. It doesn't replace the campaign endpoints on this page, so keep using V1 for those. ## Base URL ```http theme={null} https://api.deliveryman.ai/api/v1/ ``` ## Authentication V1 and V2 share the same API keys. Send yours in the `X-Api-Key` header. To create a key, go to **Integrations** in the dashboard, open **Deliveryman API Keys** and click **Manage**. ```bash theme={null} curl "https://api.deliveryman.ai/api/v1/workspaces/" \ -H "X-Api-Key: YOUR_API_KEY" ``` ## Workspaces Most V1 endpoints act on one workspace. Call [List all Workspaces](/api-reference-v1/workspaces/list-all-workspaces) first to get the `workspace_id` values your key can reach, then pass the one you want as a query parameter. ## Pagination List endpoints take `limit` and `offset` query parameters and return `data` alongside a `total` count. ## Errors V1 uses standard HTTP status codes. Error responses have a `message` field describing what went wrong. | Status | Meaning | | - | - | | `400` | The request is invalid. Check `message` for the field that failed. | | `403` | The API key is missing or invalid. | | `404` | The workspace, campaign or record doesn't exist. | | `5xx` | Something went wrong on our side. Retry later. |