Set default x-workspace-key and x-service-provider headers for subsequent API calls.

Return the current wallet balance for the active workspace.

Retrieve all workspaces associated with the account.

List domains in the active workspace. Use set_context to choose the workspace.

Check if a domain is available for registration and return pricing.

Purchase one or more domains. Prefers wallet funds if sufficient; otherwise returns a payment link.

Create N mailboxes on every domain in the active workspace with zero mailboxes.

Add credentials for a third-party export integration.

Invoke any Zapmail API endpoint by its documentation slug or an explicit path.

Create professional mailbox usernames from a full name or single word using built-in patterns.

Generate culturally appropriate firstname/lastname pairs for a given ethnicity and gender.

Generate professional domain name suggestions (local rules).

Check availability and pricing for multiple domains at once.

Give a natural language instruction (e.g., 'buy 5 domains and connect Instantly') and the server will plan steps and optionally execute them.

Retrieve system metrics including API call statistics, cache performance, and error rates.

Clear all cached data to free memory and ensure fresh data retrieval.

Perform a comprehensive health check of the MCP server including API connectivity, cache status, and configuration validation.

Update multiple mailboxes with new names, usernames, or other properties in a single operation.

Search for mailboxes using various criteria like name, username, domain, or status.

Retrieve detailed information about the MCP server configuration, features, and capabilities.

Get comprehensive information about supported export platforms, flows, and scenarios.

Get step-by-step instructions for specific export scenarios.

Validate export request parameters before execution to prevent errors.

Get AI-powered guidance for export operations including best practices and recommendations.

Get detailed information about API endpoints, parameters, responses, and usage examples.

Search for API endpoints using keywords to find relevant functionality.

Get step-by-step scenarios for common API operations and workflows.

Get comprehensive best practices for using the Zapmail API effectively.

Generate practical examples for API endpoint usage with custom parameters.

API Docs Invoke this endpoint.

Use this endpoint to fetch details of the authenticated user, including their active plan, mailbox usage, and wallet balance. Invoke this endpoint.

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. Invoke this endpoint.

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. Invoke this endpoint.

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. Invoke this endpoint.

Use this endpoint to add billing information for a workspace. Billing details include the user’s name, company, address, and contact information. Invoke this endpoint.

Use this endpoint to update billing information for a workspace. You can update the user’s name, company, address, and contact details. Invoke this endpoint.

This endpoint lets you fetch a list of all mailboxes. Invoke this endpoint.

Use this endpoint to retrieve the details of a specific mailbox by its ID. Invoke this endpoint.

This endpoint allows you to assign new mailboxes to specific domains. Invoke this endpoint.

This endpoint allows updating mailbox details, including: Invoke this endpoint.

This endpoint allows you to schedule the removal of mailboxes on the next renewal. You can also cancel a previously scheduled removal. Invoke this endpoint.

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. Invoke this endpoint.

This endpoint is used to instantly remove one or more mailboxes from the system. It supports bulk removal. Invoke this endpoint.

• payments & wallet Add balance to wallet: This endpoint returns a stripe checkout session link to add balance to a user's wallet. Invoke this endpoint.

This endpoint retrieves the current wallet balance. Invoke this endpoint.

This endpoint allows users to enable or disable auto-recharge for their wallet. Invoke this endpoint.

This endpoint allows you to export mailboxes to a third-party application or as a CSV file. Invoke this endpoint.

This endpoint allows you to add a third-party account where you want to export your mailboxes. Supported apps: Invoke this endpoint.

This endpoint allows you to update an existing third-party account used for exporting mailboxes. Invoke this endpoint.

Fetch all subscriptions associated with the authenticated user, including active, cancelled, and expired subscriptions, along with plan and billing details. Invoke this endpoint.

Cancel a user subscription by providing its subscription ID. Invoke this endpoint.

Upgrade an existing subscription by providing a new plan key and the subscription ID. Invoke this endpoint.

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. Invoke this endpoint.

Retrieves a complete list of domains available in the system. Invoke this endpoint.

This endpoint provides a list of domains to which you can assign mailboxes. Invoke this endpoint.

This endpoint lets you add a DMARC record to one or more domains. Use contains, status and tagIds attribute to filter domains. Invoke this endpoint.

Enables redirection from one or more registered domains to a specified destination domain. Invoke this endpoint.

Get nameservers Invoke this endpoint.

Verify Name Servers for Domain Connection with Zapmail Invoke this endpoint.

Connect Domain with Zapmail Invoke this endpoint.

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. Invoke this endpoint.

Deactivate email forwarding for your domain, stopping the forwarding of emails from your domain to the specified email address. Invoke this endpoint.

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. Invoke this endpoint.

Remove catch-all email functionality for your domain, stopping the forwarding of all emails sent to any address at the domain. Invoke this endpoint.

Check DNS Records for Domain Invoke this endpoint.

This endpoint allows you to remove unused domains. Invoke this endpoint.

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. Invoke this endpoint.

Get the payment link for a list of domains or purchase domains via wallet. Invoke this endpoint.

This endpoint allows you to retrieve a list of domains that are still in progress and pending connection with Zapmail. Invoke this endpoint.

Remove a domain connection request which is pending. Invoke this endpoint.

Use this endpoint to connect domain to Zapmail. Invoke this endpoint.

Associates a Google OAuth Client ID with one or more domain IDs for a specified application. Invoke this endpoint.

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. Invoke this endpoint.

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. Invoke this endpoint.

Retrieves a complete list of domains available, with filters. Invoke this endpoint.

Fetch all DNS records for a domain associated with a user by providing the domain ID. Invoke this endpoint.

Add DNS Records for a given domain. Invoke this endpoint.

This endpoints lets you update dns records for a domain. Invoke this endpoint.

Delete DNS Record API Invoke this endpoint.

Retrieve a list of available aged/high-reputation domains from the marketplace. These are premium pre-existing domains with established history, age, and quality metrics. Invoke this endpoint.

Purchase one or more aged/high-reputation domains from the marketplace. Payment is automatically deducted from your wallet balance. Invoke this endpoint.

This endpoint retrieves available pre-warmed domains with their associated mailboxes. Pre-warmed domains are aged domains with warmed-up mailboxes that are ready for immediate use. Invoke this endpoint.

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. Invoke this endpoint.

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. Invoke this endpoint.

Retrieve all placement test subscriptions for the authenticated user. Returns both active and cancelled subscriptions, including Monthly recurring subscriptions and LTD (Lifetime Deal) plans. Invoke this endpoint.

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. Invoke this endpoint.

• placement test Get report by cart order id: 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. Invoke this endpoint.

Retrieve a list of mailboxes eligible for placement testing. Allows filtering by status, tags, and search terms to find specific mailboxes. Invoke this endpoint.

Retrieve information about available placement test credits (slots) across all active subscriptions. Returns total available credits, used credits, and breakdown by subscription. Invoke this endpoint.

Run placement tests on selected mailboxes. Supports two payment modes: Invoke this endpoint.

Purchase a placement test subscription plan (Monthly or LTD). Payment is automatically deducted from your wallet balance. Invoke this endpoint.

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. Invoke this endpoint.

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. Invoke this endpoint.

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. Invoke this endpoint.

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. Invoke this endpoint.

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. Invoke this endpoint.

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. Invoke this endpoint.

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. Invoke this endpoint.

Cancel a DNS Shield subscription immediately. This endpoint works for both Monthly recurring subscriptions and LTD (Lifetime Deal) plans. Invoke this endpoint.

Invoke this endpoint.