# Deliveryman AI

## Docs

- [Create Email Sequence](https://docs.deliveryman.ai/api-reference/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.
- [Delete Email Sequence](https://docs.deliveryman.ai/api-reference/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 Email Sequences](https://docs.deliveryman.ai/api-reference/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/campaign-email-sequence/retrieve-email-sequence.md): Returns details for a given campaign email sequence.
- [Update Email Sequence](https://docs.deliveryman.ai/api-reference/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.
- [Cancel Campaign](https://docs.deliveryman.ai/api-reference/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.
- [Cancel Scheduled Start](https://docs.deliveryman.ai/api-reference/campaign/cancel-scheduled-start.md): Cancels auto-start schedule which was set for a campaign using `/campaign/schedule` POST request.
- [Change Campaign Contact List](https://docs.deliveryman.ai/api-reference/campaign/change-campaign-contact-list.md): Updates campaign to use a different contact list. 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 upd…
- [Create new Campaign](https://docs.deliveryman.ai/api-reference/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.
- [Email Open Events](https://docs.deliveryman.ai/api-reference/campaign/email-open-events.md): Returns list of email open event data for given campaign.
- [Link Click Events](https://docs.deliveryman.ai/api-reference/campaign/link-click-events.md): Returns list of link click event data for given campaign.
- [List all Campaigns](https://docs.deliveryman.ai/api-reference/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.
- [Pause Campaign](https://docs.deliveryman.ai/api-reference/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/campaign/resume-campaign.md): Resumes the given paused campaign.
- [Retrieve Campaign](https://docs.deliveryman.ai/api-reference/campaign/retrieve-campaign.md): Fetches details for a single campaign.
- [Scheduled Start](https://docs.deliveryman.ai/api-reference/campaign/scheduled-start.md): Schedules the campaign to start automatically at a given future date.
- [Start Campaign](https://docs.deliveryman.ai/api-reference/campaign/start-campaign.md): Starts the given campaign immediately.
- [Update Campaign](https://docs.deliveryman.ai/api-reference/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`.
- [List all Contact Lists](https://docs.deliveryman.ai/api-reference/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 Domains](https://docs.deliveryman.ai/api-reference/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 Leads](https://docs.deliveryman.ai/api-reference/leads/list-all-leads.md): Retrieves all leads data for the given campaign.
- [Retrieve a Lead](https://docs.deliveryman.ai/api-reference/leads/retrieve-a-lead.md): Returns details for the given Lead.
- [List all Campaign Replies](https://docs.deliveryman.ai/api-reference/replies/list-all-campaign-replies.md): Returns all reply data for the given campaign.
- [List all Workspaces](https://docs.deliveryman.ai/api-reference/workspaces/list-all-workspaces.md): Returns all workspaces belonging to the authenticated user.

## OpenAPI Specs

- [openapi](https://docs.deliveryman.ai/openapi.yml)