# Zapmail ## Docs - [Zapmail Docs](https://docs.zapmail.ai/zapmail-docs-825990m0.md): ## API Docs - users [Retrieve User Details](https://docs.zapmail.ai/retrieve-user-details-13489341e0.md): Use this endpoint to fetch details of the authenticated user, including their active plan, mailbox usage, and wallet balance. - workspaces [Retrieve all workspaces](https://docs.zapmail.ai/retrieve-all-workspaces-13489896e0.md): Use this endpoint to retrieve a list of all workspaces associated with the authenticated user. You can filter the results using pagination parameters and an optional search keyword. - workspaces [Create new workspace](https://docs.zapmail.ai/create-new-workspace-13489947e0.md): Use this endpoint to create a new workspace for your Zapmail account. Each workspace can hold domains, mailboxes, and user-specific settings. Workspace names must be unique per account. - workspaces [Update workspace](https://docs.zapmail.ai/update-workspace-13489975e0.md): Use this endpoint to update an existing workspace’s name. Make sure the workspace ID is correct and that the new name does not conflict with another workspace in your account. - workspaces [List all workspace members](https://docs.zapmail.ai/list-all-workspace-members-26769014e0.md): List all workspace members with their roles and details - workspaces [Update user role](https://docs.zapmail.ai/update-user-role-26769213e0.md): Update user role/access level (ADMIN, EDITOR, VIEWER) - workspaces [Revoke User Access](https://docs.zapmail.ai/revoke-user-access-26769219e0.md): Revoke user access / remove member from workspace - workspaces [Send invitiation to join workspace](https://docs.zapmail.ai/send-invitiation-to-join-workspace-26777742e0.md): Send invitation to a new member to join workspace - workspaces [List all invitations](https://docs.zapmail.ai/list-all-invitations-26777875e0.md): List all workspace invitations (pending, accepted, rejected, revoked) - workspaces [Revoke invitation](https://docs.zapmail.ai/revoke-invitation-26778624e0.md): Cancel/revoke a pending invitation - billing [Add Billing Details](https://docs.zapmail.ai/add-billing-details-13490005e0.md): Use this endpoint to add billing information for a workspace. Billing details include the user’s name, company, address, and contact information. - billing [ Update Billing Details](https://docs.zapmail.ai/-update-billing-details-13517578e0.md): Use this endpoint to update billing information for a workspace. You can update the user’s name, company, address, and contact details. - mailbox [Retrieve All Mailboxes](https://docs.zapmail.ai/retrieve-all-mailboxes-13490172e0.md): This endpoint lets you fetch a list of all mailboxes. - mailbox [Get Mailbox Details by ID](https://docs.zapmail.ai/get-mailbox-details-by-id-13490215e0.md): Use this endpoint to retrieve the details of a specific mailbox by its ID. - mailbox [Assign New Mailboxes to Domains](https://docs.zapmail.ai/assign-new-mailboxes-to-domains-13490321e0.md): This endpoint allows you to assign new mailboxes to specific domains. - mailbox [Update mailbox](https://docs.zapmail.ai/update-mailbox-13490429e0.md): This endpoint allows updating mailbox details, including: - mailbox [Remove mailboxes on next renewal](https://docs.zapmail.ai/remove-mailboxes-on-next-renewal-13490521e0.md): This endpoint allows you to schedule the removal of mailboxes from a domain on the next renewal. You can also cancel a previously scheduled removal. - mailbox [Get Authenticator code](https://docs.zapmail.ai/get-authenticator-code-13648760e0.md): This endpoint allows you to retrieve an authenticator code for a specific mailbox. The code can be used for authentication purposes and has a limited validity period. - mailbox [Remove Mailboxes Instantly](https://docs.zapmail.ai/remove-mailboxes-instantly-19455787e0.md): This endpoint is used to instantly remove one or more mailboxes from the system. It supports bulk removal. - mailbox [Custom OAuth](https://docs.zapmail.ai/custom-oauth-23834066e0.md): - mailbox [schedule mailbox creation](https://docs.zapmail.ai/schedule-mailbox-creation-26753639e0.md): Schedule mailbox creation for single or bulk mailboxes. Mailboxes are scheduled to be created on the next subscription renewal date. Supports bulk scheduling by passing multiple domains with multiple mailboxes in the payload. - mailbox [retry creation of failed mailboxes](https://docs.zapmail.ai/retry-creation-of-failed-mailboxes-26753642e0.md): - payments & wallet [Add balance to wallet](https://docs.zapmail.ai/add-balance-to-wallet-13490582e0.md): This endpoint returns a stripe checkout session link to add balance to a user's wallet. - payments & wallet [Get wallet balance](https://docs.zapmail.ai/get-wallet-balance-13490707e0.md): This endpoint retrieves the current wallet balance. - payments & wallet [Enable auto recharge](https://docs.zapmail.ai/enable-auto-recharge-13490713e0.md): This endpoint allows users to enable or disable auto-recharge for their wallet. - payments & wallet [Purchase add on mailboxes](https://docs.zapmail.ai/purchase-add-on-mailboxes-26273085e0.md): The Mailbox Add-on Public API allows users to purchase additional mailboxes beyond their base plan allocation using their wallet balance. - payments & wallet [get invoices for subscription](https://docs.zapmail.ai/get-invoices-for-subscription-26753647e0.md): Fetch invoice URL for a given subscription. - export [Export mailboxes](https://docs.zapmail.ai/export-mailboxes-13490737e0.md): This endpoint allows you to export mailboxes to a third-party application or as a CSV file. - export [Add third party account details](https://docs.zapmail.ai/add-third-party-account-details-13490752e0.md): This endpoint allows you to add a third-party account where you want to export your mailboxes. Supported apps: - export [Update third party account details](https://docs.zapmail.ai/update-third-party-account-details-13490787e0.md): This endpoint allows you to update an existing third-party account used for exporting mailboxes. - export [Get Export Status](https://docs.zapmail.ai/get-export-status-26823880e0.md): Retrieve the current status of a mailbox export operation. - export [Fetch Workspaces by App](https://docs.zapmail.ai/fetch-workspaces-by-app-28045428e0.md): ## Fetch Workspaces (Exports) - subscriptions [Get all subscriptions](https://docs.zapmail.ai/get-all-subscriptions-13489431e0.md): Fetch all subscriptions associated with the authenticated user, including active, cancelled, and expired subscriptions, along with plan and billing details. - subscriptions [Cancel subscription](https://docs.zapmail.ai/cancel-subscription-13489478e0.md): Cancel a subscription or revert a previous cancellation. The same endpoint handles both operations via the revertCancellation flag. - subscriptions [Upgrade existing subscription](https://docs.zapmail.ai/upgrade-existing-subscription-13489501e0.md): Upgrade an existing subscription by providing a new plan key and the subscription ID. - subscriptions [Purchase subscription](https://docs.zapmail.ai/purchase-subscription-25771049e0.md): This endpoint allows you to purchase a Zapmail subscription plan using your wallet balance. Payment is processed exclusively through your wallet, with automatic recharge if enabled. - subscriptions [Get Mailboxes in a Subscription](https://docs.zapmail.ai/get-mailboxes-in-a-subscription-26753919e0.md): Retrieve the list of mailboxes associated with a specific subscription. - domains [Retrieve All Domains](https://docs.zapmail.ai/retrieve-all-domains-13520015e0.md): Retrieves a complete list of domains available in the system. - domains [List Assignable Domains](https://docs.zapmail.ai/list-assignable-domains-13520727e0.md): This endpoint provides a list of domains to which you can assign mailboxes. - domains [Add DMARC record](https://docs.zapmail.ai/add-dmarc-record-13520817e0.md): This endpoint lets you add a DMARC record to one or more domains. Use contains, status and tagIds attribute to filter domains. - domains [Add Domain forwarding](https://docs.zapmail.ai/add-domain-forwarding-13520843e0.md): Enables redirection from one or more registered domains to a specified destination domain. - domains [Get Name servers to connect domain](https://docs.zapmail.ai/get-name-servers-to-connect-domain-13520972e0.md): # Get nameservers - domains [Verify Name Server Propagation](https://docs.zapmail.ai/verify-name-server-propagation-13520984e0.md): # Verify Name Servers for Domain Connection with Zapmail - domains [Connect Domain with Zapmail](https://docs.zapmail.ai/connect-domain-with-zapmail-13521006e0.md): # Connect Domain with Zapmail - domains [Enable email forwarding](https://docs.zapmail.ai/enable-email-forwarding-13521023e0.md): This api enables email forwarding for one or more registered domains. Email forwarding redirects all incoming emails sent to the target domain's mailboxes to a designated recipient address. - domains [Remove email forwarding](https://docs.zapmail.ai/remove-email-forwarding-13521037e0.md): Deactivate email forwarding for your domain, stopping the forwarding of emails from your domain to the specified email address. - domains [Enable catch all emails](https://docs.zapmail.ai/enable-catch-all-emails-13521061e0.md): Add catch-all email functionality for your domains, ensuring that any email sent to an undefined address under the domain is automatically forwarded to a specified recipient. - domains [Remove catch all emails](https://docs.zapmail.ai/remove-catch-all-emails-13521079e0.md): Remove catch-all email functionality for your domain, stopping the forwarding of all emails sent to any address at the domain. - domains [Check DNS records](https://docs.zapmail.ai/check-dns-records-13521093e0.md): # Check DNS Records for Domain - domains [Remove unused domains](https://docs.zapmail.ai/remove-unused-domains-13521144e0.md): This endpoint allows you to remove unused domains. - domains [Get available domains for registration](https://docs.zapmail.ai/get-available-domains-for-registration-13521189e0.md): This endpoint returns a list of domains that are available for registration, along with the exact match and a list of similar domains for a given set of TLDs and years of registration. - domains [Get domains purchase payment link](https://docs.zapmail.ai/get-domains-purchase-payment-link-13521209e0.md): Get the payment link for a list of domains or purchase domains via wallet. - domains [Get domain connection requests](https://docs.zapmail.ai/get-domain-connection-requests-18247843e0.md): This endpoint allows you to retrieve a list of domains that are still in progress and pending connection with Zapmail. - domains [Remove domain connection requests](https://docs.zapmail.ai/remove-domain-connection-requests-18247913e0.md): Remove a domain connection request which is pending. - domains [Connect Domain with Zapmail (New)](https://docs.zapmail.ai/connect-domain-with-zapmail-new-18248433e0.md): Use this endpoint to connect domain to Zapmail. - domains [Add Google Client ID to Domain](https://docs.zapmail.ai/add-google-client-id-to-domain-19401086e0.md): Associates a Google OAuth Client ID with one or more domain IDs for a specified application. - domains [Get availability of multiple domain names.](https://docs.zapmail.ai/get-availability-of-multiple-domain-names-22701420e0.md): This endpoint allows you to check the availability of up to 20 domain names in a single request. This is ideal for bulk domain searches, letting you quickly determine which domains are available for registration and their corresponding prices for the specified number of years. - domains [Retrieve Domain Health Score](https://docs.zapmail.ai/retrieve-domain-health-score-25772162e0.md): This endpoint provides a reputation score for your domain based on its nameserver reputation. This helps you monitor whether your domain's DNS infrastructure is on any abuse lists and assess the overall health of your domain. - domains [Retrieve All Domains (With filters)](https://docs.zapmail.ai/retrieve-all-domains-with-filters-26049361e0.md): Retrieves a complete list of domains available, with filters. - domains [AI Domain Finder](https://docs.zapmail.ai/ai-domain-finder-26765390e0.md): Generate AI-suggested available domains based on keywords. First call starts generation, subsequent polls return progress and results. - domains [Move Domains Across workspace](https://docs.zapmail.ai/move-domains-across-workspace-26765446e0.md): - domains [Assign Domain Tag](https://docs.zapmail.ai/assign-domain-tag-26767208e0.md): Assign tags to domains (bulk operation). - domains [list domain tags](https://docs.zapmail.ai/list-domain-tags-26824030e0.md): Retrieve all tags for the authenticated user's workspace. - domains [Create Domain Tags](https://docs.zapmail.ai/create-domain-tags-26824278e0.md): - domains [Remove Domain Forwarding](https://docs.zapmail.ai/remove-domain-forwarding-26849158e0.md): Removes email forwarding configuration from a domain. - dns [Get dns records ](https://docs.zapmail.ai/get-dns-records-13627177e0.md): Fetch all DNS records for a domain associated with a user by providing the domain ID. - dns [Add dns records](https://docs.zapmail.ai/add-dns-records-13629231e0.md): Add DNS Records for a given domain. - dns [Update dns records](https://docs.zapmail.ai/update-dns-records-13629370e0.md): This endpoints lets you update dns records for a domain. - dns [Delete dns records](https://docs.zapmail.ai/delete-dns-records-14109023e0.md): ## Delete DNS Record API - High Reputation Domains [Get available domains](https://docs.zapmail.ai/get-available-domains-25772286e0.md): Retrieve a list of available high-reputation domains from the marketplace. These are premium pre-existing domains with established history, age, and quality metrics. - High Reputation Domains [Purchase high reputation domains](https://docs.zapmail.ai/purchase-high-reputation-domains-25772684e0.md): Purchase one or more high-reputation domains from the marketplace. Payment is automatically deducted from your wallet balance. - prewarmed domains [Get prewarmed domains](https://docs.zapmail.ai/get-prewarmed-domains-25774188e0.md): This endpoint retrieves available pre-warmed domains with their associated mailboxes. Pre-warmed domains are domains with warmed-up mailboxes that are ready for immediate use. - prewarmed domains [purchase prewarmed subscription](https://docs.zapmail.ai/purchase-prewarmed-subscription-25774263e0.md): This endpoint allows you to purchase a pre-warmed subscription plan using your wallet balance. Pre-warmed plans include aged domains with warmed-up mailboxes ready for immediate use, ensuring better email deliverability. - prewarmed domains [Assign prewarmed mailboxes](https://docs.zapmail.ai/assign-prewarmed-mailboxes-25774338e0.md): This endpoint assigns pre-warmed domains to fill available slots in your pre-warmed subscription. When you assign domains, their mailboxes are automatically transferred to your account. - prewarmed domains [Get Available Domains Count](https://docs.zapmail.ai/get-available-domains-count-26754452e0.md): Get count of available pre-warmed up domains (not yet sold) by service provider. - placement test [Get subscriptions](https://docs.zapmail.ai/get-subscriptions-25778521e0.md): Retrieve all placement test subscriptions for the authenticated user. Returns both active and cancelled subscriptions, including Monthly recurring subscriptions and LTD (Lifetime Deal) plans. - placement test [Get Overall Report](https://docs.zapmail.ai/get-overall-report-25778661e0.md): Retrieve an overall summary of all placement test results. This endpoint aggregates data across all your placement tests, providing insights into email deliverability performance across different providers and mailboxes. - placement test [Get placement test orders](https://docs.zapmail.ai/get-placement-test-orders-25779469e0.md): Get placement test orders with their results, aggregated by cart order. - placement test [Get report by cart order id](https://docs.zapmail.ai/get-report-by-cart-order-id-25779763e0.md): Retrieve a detailed placement test report for a specific cart order. Returns comprehensive deliverability metrics, provider-specific results, and detailed analysis for all mailboxes in the cart order. - placement test [Get Eligible Mailboxes for Placement Tests](https://docs.zapmail.ai/get-eligible-mailboxes-for-placement-tests-25779778e0.md): Retrieve a list of mailboxes eligible for placement testing. Allows filtering by status, tags, and search terms to find specific mailboxes. - placement test [Get Available Placement Test Credits](https://docs.zapmail.ai/get-available-placement-test-credits-25779804e0.md): Retrieve information about available placement test credits (slots) across all active subscriptions. Returns total available credits, used credits, and breakdown by subscription. - placement test [Purchase Placement Test](https://docs.zapmail.ai/purchase-placement-test-25780176e0.md): Run placement tests on selected mailboxes. Supports two payment modes: - placement test [Purchase plan](https://docs.zapmail.ai/purchase-plan-25780426e0.md): Purchase a placement test subscription plan (Monthly or LTD). Payment is automatically deducted from your wallet balance. - placement test [Cancel Subscription](https://docs.zapmail.ai/cancel-subscription-26754449e0.md): Cancel a placement test subscription or revert a previous cancellation. - dns shield [Get eligible domains](https://docs.zapmail.ai/get-eligible-domains-25781361e0.md): Retrieve a paginated list of domains that are eligible for DNS Shield protection. This endpoint helps you identify which of your domains can be protected with DNS Shield before making a purchase. - dns shield [Get available slots](https://docs.zapmail.ai/get-available-slots-25781438e0.md): Check how many available DNS Shield slots you have across all your LTD (Lifetime Deal) subscriptions. This endpoint calculates the total available capacity by subtracting used slots from your total slots across all active LTD plans. - dns shield [Get subscriptions](https://docs.zapmail.ai/get-subscriptions-25781447e0.md): Retrieve all DNS Shield subscriptions (both Monthly and LTD) for the authenticated user. This endpoint returns comprehensive details about each subscription including status, pricing, billing cycle, slot capacity, and usage. - dns shield [Get Allocated Domains for Subscription](https://docs.zapmail.ai/get-allocated-domains-for-subscription-25781672e0.md): Retrieve all domains that are currently allocated to a specific DNS Shield subscription. This endpoint provides detailed information about each domain including its status, mailboxes, and registration details. - dns shield [Allocate Domains to DNS Shield](https://docs.zapmail.ai/allocate-domains-to-dns-shield-25781833e0.md): Allocate domains to your DNS Shield LTD subscription slots and enable DNS Shield protection. This endpoint assigns specific domains to your available LTD plan capacity and automatically configures DNS Shield protection. - dns shield [Purchase DNS Shield](https://docs.zapmail.ai/purchase-dns-shield-25782088e0.md): Purchase a Lifetime Deal (LTD) DNS Shield plan with a one-time payment. LTD plans provide DNS Shield protection for a fixed number of domains without recurring monthly charges. - dns shield [Upgrade DNS Shield LTD Plan](https://docs.zapmail.ai/upgrade-dns-shield-ltd-plan-25782123e0.md): Purchase a Lifetime Deal (LTD) DNS Shield plan with a one-time payment. LTD plans provide DNS Shield protection for a fixed number of domains without recurring monthly charges. - dns shield [Cancel subscription](https://docs.zapmail.ai/cancel-subscription-25783127e0.md): Cancel a DNS Shield subscription immediately. This endpoint works for both Monthly recurring subscriptions and LTD (Lifetime Deal) plans. - global [Global mailbox-domain search](https://docs.zapmail.ai/global-mailbox-domain-search-26754309e0.md): Unified dashboard search - retrieve mailbox and workspace details for a given domain or mailbox email. Returns mailboxes grouped by domain, along with workspace information and service provider type. - zapbox [List Connected Accounts](https://docs.zapmail.ai/list-connected-accounts-26767206e0.md): Retrieve list of email accounts connected to the user/workspace - zapbox [Fetch emails](https://docs.zapmail.ai/fetch-emails-26786130e0.md): Fetch paginated list of emails from a connected email account. - zapbox [get emails from a thread](https://docs.zapmail.ai/get-emails-from-a-thread-26786134e0.md): Get all emails in a specific conversation thread - zapbox [Search emails](https://docs.zapmail.ai/search-emails-26786136e0.md): Search emails with filters and query parameters - zapbox [Send Email](https://docs.zapmail.ai/send-email-26824942e0.md): Send an email from a specified mailbox account. - zapbox [Download Attachment](https://docs.zapmail.ai/download-attachment-26824997e0.md): Download an email attachment by its ID - zapbox [Create New Label](https://docs.zapmail.ai/create-new-label-26825165e0.md): Create a new email label/folder for an account. - zapbox [Delete Label](https://docs.zapmail.ai/delete-label-26825170e0.md): Delete an existing email label/folder. - zapbox [Rename Label](https://docs.zapmail.ai/rename-label-26825177e0.md): Rename an existing email label/folder. ## Schemas - [domain with filter](https://docs.zapmail.ai/domain-with-filter-10125073d0.md):