# 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.
- 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 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): 
- 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.
- 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.
- 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 user subscription by providing its subscription ID.
- 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.
- 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.
- 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