Zapmail
Cold-email mailboxes and domains.
OutboundAPI key110 endpoints
Endpoints
| Operation | Method & path | Effect | Latency | Rate | Cost |
|---|---|---|---|---|---|
get_users Retrieve User Details docs ↗ | GET /v2/users | none | <1s | 5/s | no bill |
post_quick_setup Quick Setup docs ↗ | POST /v2/quick-setup | paid_provider | 1-5s | 5/s | no bill |
get_workspaces Retrieve all workspaces docs ↗ | GET /v2/workspaces | none | <1s | 5/s | no bill |
post_workspaces Create new workspace docs ↗ | POST /v2/workspaces | crm_write | 1-5s | 5/s | no bill |
put_workspaces Update workspace docs ↗ | PUT /v2/workspaces | crm_write | 1-5s | 5/s | no bill |
get_workspaces_members List all workspace members docs ↗ | GET /v2/workspaces/members | none | <1s | 5/s | no bill |
put_workspaces_members Update user role docs ↗ | PUT /v2/workspaces/members | crm_write | 1-5s | 5/s | no bill |
delete_workspaces_members Revoke User Access docs ↗ | DELETE /v2/workspaces/members | crm_write | 1-5s | 5/s | no bill |
post_workspaces_invitations Send invitiation to join workspace docs ↗ | POST /v2/workspaces/invitations | external_send | 1-5s | 5/s | no bill |
get_workspaces_invitations List all invitations docs ↗ | GET /v2/workspaces/invitations | none | <1s | 5/s | no bill |
delete_workspaces_invitations Revoke invitation docs ↗ | DELETE /v2/workspaces/invitations | external_send | 1-5s | 5/s | no bill |
post_workspaces_update_domain_renewal_settings Update Domain Renewal Settings docs ↗ | POST /v2/workspaces/update-domain-renewal-settings | paid_provider | 1-5s | 5/s | no bill |
post_billing Add Billing Details docs ↗ | POST /v2/billing | crm_write | 1-5s | 5/s | no bill |
put_billing Update Billing Details docs ↗ | PUT /v2/billing | crm_write | 1-5s | 5/s | no bill |
get_mailboxes_list Retrieve All Mailboxes docs ↗ | GET /v2/mailboxes/list | none | <1s | 5/s | no bill |
get_mailboxes Get Mailbox Details by ID docs ↗ | GET /v2/mailboxes | none | <1s | 5/s | no bill |
post_mailboxes Assign New Mailboxes to Domains docs ↗ | POST /v2/mailboxes | paid_provider | 1-5s | 5/s | no bill |
put_mailboxes Update mailbox docs ↗ | PUT /v2/mailboxes | paid_provider | 1-5s | 5/s | no bill |
put_mailboxes_scheduled_removal Remove mailboxes on next renewal docs ↗ | PUT /v2/mailboxes/scheduled-removal | paid_provider | 1-5s | 5/s | no bill |
get_mailboxes_authenticator_code Get Authenticator code docs ↗ | GET /v2/mailboxes/authenticator-code | none | <1s | 5/s | no bill |
post_mailboxes_custom_oauth Custom OAuth docs ↗ | POST /v2/mailboxes/custom-oauth | paid_provider | 1-5s | 5/s | no bill |
post_mailboxes_schedule schedule mailbox creation docs ↗ | POST /v2/mailboxes/schedule | paid_provider | 1-5s | 5/s | no bill |
put_mailboxes_retry_failed retry creation of failed mailboxes docs ↗ | PUT /v2/mailboxes/retry-failed | paid_provider | 1-5s | 5/s | no bill |
post_wallet_balance Add balance to wallet docs ↗ | POST /v2/wallet/balance | paid_provider | 1-5s | 5/s | no bill |
get_wallet_balance Get wallet balance docs ↗ | GET /v2/wallet/balance | none | <1s | 5/s | no bill |
post_wallet_enable_auto_recharge Enable auto recharge docs ↗ | POST /v2/wallet/enable-auto-recharge | paid_provider | 1-5s | 5/s | no bill |
post_wallet_buy_addon_mailboxes Purchase add on mailboxes docs ↗ | POST /v2/wallet/buy-addon-mailboxes | paid_provider | 1-5s | 5/s | no bill |
post_payment_invoices get invoices for subscription docs ↗ | POST /v2/payment/invoices | paid_provider | 1-5s | 5/s | no bill |
post_exports_mailboxes Export mailboxes docs ↗ | POST /v2/exports/mailboxes | paid_provider | 1-5s | 5/s | no bill |
post_exports_accounts_third_party Add third party account details docs ↗ | POST /v2/exports/accounts/third-party | paid_provider | 1-5s | 5/s | no bill |
put_exports_accounts_third_party Update third party account details docs ↗ | PUT /v2/exports/accounts/third-party | paid_provider | 1-5s | 5/s | no bill |
get_exports_status Get Export Status docs ↗ | GET /v2/exports/status | none | <1s | 5/s | no bill |
get_exports_fetch_workspaces Fetch Workspaces by App docs ↗ | GET /v2/exports/fetch-workspaces | none | <1s | 5/s | no bill |
get_exports_accounts_third_party List all third-party accounts docs ↗ | GET /v2/exports/accounts/third-party | none | <1s | 5/s | no bill |
get_subscriptions Get all subscriptions docs ↗ | GET /v2/subscriptions | none | <1s | 5/s | no bill |
post_subscriptions_cancel Cancel subscription docs ↗ | POST /v2/subscriptions/cancel | paid_provider | 1-5s | 5/s | no bill |
post_subscriptions_upgrade Upgrade existing subscription docs ↗ | POST /v2/subscriptions/upgrade | paid_provider | 1-5s | 5/s | no bill |
post_subscriptions_purchase Purchase subscription docs ↗ | POST /v2/subscriptions/purchase | paid_provider | 1-5s | 5/s | no bill |
post_subscriptions_mailboxes Get Mailboxes in a Subscription docs ↗ | POST /v2/subscriptions/mailboxes | paid_provider | 1-5s | 5/s | no bill |
get_domains Retrieve All Domains docs ↗ | GET /v2/domains | none | <1s | 5/s | no bill |
get_domains_assignable List Assignable Domains docs ↗ | GET /v2/domains/assignable | none | <1s | 5/s | no bill |
post_domains_dmarc Add DMARC record docs ↗ | POST /v2/domains/dmarc | paid_provider | 1-5s | 5/s | no bill |
post_domains_forwarding Add Domain forwarding docs ↗ | POST /v2/domains/forwarding | paid_provider | 1-5s | 5/s | no bill |
post_domains_name_servers Get Name servers to connect domain docs ↗ | POST /v2/domains/name-servers | paid_provider | 1-5s | 5/s | no bill |
post_domains_name_servers_verify Verify Name Server Propagation docs ↗ | POST /v2/domains/name-servers/verify | paid_provider | 1-5s | 5/s | no bill |
post_domains_connect_domain Connect Domain with Zapmail docs ↗ | POST /v2/domains/connect-domain | paid_provider | 1-5s | 5/s | no bill |
post_domains_email_forwarding Enable email forwarding docs ↗ | POST /v2/domains/email-forwarding | paid_provider | 1-5s | 5/s | no bill |
delete_domains_email_forwarding Remove email forwarding docs ↗ | DELETE /v2/domains/email-forwarding | paid_provider | 1-5s | 5/s | no bill |
post_domains_catch_all Enable catch all emails docs ↗ | POST /v2/domains/catch-all | paid_provider | 1-5s | 5/s | no bill |
delete_domains_catch_all Remove catch all emails docs ↗ | DELETE /v2/domains/catch-all | paid_provider | 1-5s | 5/s | no bill |
post_domains_dns_check Check DNS records docs ↗ | POST /v2/domains/dns/check | paid_provider | 1-5s | 5/s | no bill |
delete_domains Remove unused domains docs ↗ | DELETE /v2/domains | paid_provider | 1-5s | 5/s | no bill |
post_domains_available Get available domains for registration docs ↗ | POST /v2/domains/available | paid_provider | 1-5s | 5/s | no bill |
post_domains_buy Get domains purchase payment link docs ↗ | POST /v2/domains/buy | paid_provider | 1-5s | 5/s | no bill |
get_domains_connection_requests Get domain connection requests docs ↗ | GET /v2/domains/connection-requests | none | <1s | 5/s | no bill |
delete_domains_connection_requests Remove domain connection requests docs ↗ | DELETE /v2/domains/connection-requests | paid_provider | 1-5s | 5/s | no bill |
post_domains_add_client_id Add Google Client ID to Domain docs ↗ | POST /v2/domains/add-client-id | paid_provider | 1-5s | 5/s | no bill |
post_domains_available_bulk Get availability of multiple domain names. docs ↗ | POST /v2/domains/available-bulk | paid_provider | 1-5s | 5/s | no bill |
get_domains_health_score Retrieve Domain Health Score docs ↗ | GET /v2/domains/health-score | none | <1s | 5/s | no bill |
post_domains Retrieve All Domains (With filters) docs ↗ | POST /v2/domains | paid_provider | 1-5s | 5/s | no bill |
post_domains_ai_finder AI Domain Finder docs ↗ | POST /v2/domains/ai-finder | paid_provider | 1-5s | 5/s | no bill |
post_domains_move_workspace Move Domains Across workspace docs ↗ | POST /v2/domains/move-workspace | paid_provider | 1-5s | 5/s | no bill |
post_domains_assign_tag Assign Domain Tag docs ↗ | POST /v2/domains/assign-tag | paid_provider | 1-5s | 5/s | no bill |
get_domains_tags list domain tags docs ↗ | GET /v2/domains/tags | none | <1s | 5/s | no bill |
post_domains_tags Create Domain Tags docs ↗ | POST /v2/domains/tags | paid_provider | 1-5s | 5/s | no bill |
post_domains_remove_forwarding Remove Domain Forwarding docs ↗ | POST /v2/domains/remove-forwarding | paid_provider | 1-5s | 5/s | no bill |
post_domains_renewal_soon List Domains Eligible for Renewal docs ↗ | POST /v2/domains/renewal-soon | paid_provider | 1-5s | 5/s | no bill |
post_domains_get_renewal_price Get Renewal Price docs ↗ | POST /v2/domains/get-renewal-price | paid_provider | 1-5s | 5/s | no bill |
post_domains_renew Renew Domains docs ↗ | POST /v2/domains/renew | paid_provider | 1-5s | 5/s | no bill |
post_domains_tags_delete Delete Tag docs ↗ | POST /v2/domains/tags/delete | paid_provider | 1-5s | 5/s | no bill |
post_domains_tags_remove Remove Tags From Domains docs ↗ | POST /v2/domains/tags/remove | paid_provider | 1-5s | 5/s | no bill |
post_domains_update_auto_renew Update Auto Renew Preference docs ↗ | POST /v2/domains/update-auto-renew | paid_provider | 1-5s | 5/s | no bill |
get_dns Get dns records docs ↗ | GET /v2/dns/ | none | <1s | 5/s | no bill |
post_dns Add dns records docs ↗ | POST /v2/dns | crm_write | 1-5s | 5/s | no bill |
put_dns Update dns records docs ↗ | PUT /v2/dns | crm_write | 1-5s | 5/s | no bill |
delete_dns Delete dns records docs ↗ | DELETE /v2/dns | crm_write | 1-5s | 5/s | no bill |
get_aged_domains_available_domains Get available domains docs ↗ | GET /v2/aged-domains/available-domains | none | <1s | 5/s | no bill |
post_aged_domains_purchase Purchase high reputation domains docs ↗ | POST /v2/aged-domains/purchase | paid_provider | 1-5s | 5/s | no bill |
get_prewarmed_domains_get_domains Get prewarmed domains docs ↗ | GET /v2/prewarmed-domains/get-domains | none | <1s | 5/s | no bill |
post_prewarmed_domains_purchase purchase prewarmed subscription docs ↗ | POST /v2/prewarmed-domains/purchase | paid_provider | 1-5s | 5/s | no bill |
post_prewarmed_domains_assign Assign prewarmed mailboxes docs ↗ | POST /v2/prewarmed-domains/assign | paid_provider | 1-5s | 5/s | no bill |
get_prewarmed_domains_count Get Available Domains Count docs ↗ | GET /v2/prewarmed-domains/count | none | <1s | 5/s | no bill |
get_prewarmed_domains_subscriptions Get Prewarm Subscriptions docs ↗ | GET /v2/prewarmed-domains/subscriptions | none | <1s | 5/s | no bill |
get_placement_tests_subscriptions Get subscriptions docs ↗ | GET /v2/placement-tests/subscriptions | none | <1s | 5/s | no bill |
get_placement_tests_overall_report Get Overall Report docs ↗ | GET /v2/placement-tests/overall-report | none | <1s | 5/s | no bill |
get_placement_tests_orders Get placement test orders docs ↗ | GET /v2/placement-tests/orders | none | <1s | 5/s | no bill |
get_placement_tests_report Get report by cart order id docs ↗ | GET /v2/placement-tests/report | none | <1s | 5/s | no bill |
post_placement_tests_eligible_mailboxes Get Eligible Mailboxes for Placement Tests docs ↗ | POST /v2/placement-tests/eligible-mailboxes | paid_provider | 1-5s | 5/s | no bill |
get_placement_tests_available_slots Get Available Placement Test Credits docs ↗ | GET /v2/placement-tests/available-slots | none | <1s | 5/s | no bill |
post_placement_tests_purchase Purchase Placement Test docs ↗ | POST /v2/placement-tests/purchase | paid_provider | 1-5s | 5/s | no bill |
post_placement_tests_purchase_plan Purchase plan docs ↗ | POST /v2/placement-tests/purchase-plan | paid_provider | 1-5s | 5/s | no bill |
post_placement_tests_cancel_subscription Cancel Subscription docs ↗ | POST /v2/placement-tests/cancel-subscription | paid_provider | 1-5s | 5/s | no bill |
get_dns_shield_eligible_domains Get eligible domains docs ↗ | GET /v2/dns-shield/eligible-domains | none | <1s | 5/s | no bill |
get_dns_shield_available_slots Get available slots docs ↗ | GET /v2/dns-shield/available-slots | none | <1s | 5/s | no bill |
get_dns_shield_subscriptions Get subscriptions docs ↗ | GET /v2/dns-shield/subscriptions | none | <1s | 5/s | no bill |
get_dns_shield_allocated_domains Get Allocated Domains for Subscription docs ↗ | GET /v2/dns-shield/allocated-domains | none | <1s | 5/s | no bill |
post_dns_shield_allocate_domains Allocate Domains to DNS Shield docs ↗ | POST /v2/dns-shield/allocate-domains | paid_provider | 1-5s | 5/s | no bill |
post_dns_shield_purchase Purchase DNS Shield docs ↗ | POST /v2/dns-shield/purchase | paid_provider | 1-5s | 5/s | no bill |
post_dns_shield_upgrade_plan Upgrade DNS Shield LTD Plan docs ↗ | POST /v2/dns-shield/upgrade-plan | paid_provider | 1-5s | 5/s | no bill |
post_dns_shield_cancel_subscription Cancel subscription docs ↗ | POST /v2/dns-shield/cancel-subscription | paid_provider | 1-5s | 5/s | no bill |
get_global_mailbox_domain_search Global mailbox-domain search docs ↗ | GET /v2/global/mailbox-domain-search | none | <1s | 5/s | no bill |
get_onebox_connected_accounts List Connected Accounts docs ↗ | GET /v2/onebox/connected-accounts | none | <1s | 5/s | no bill |
get_onebox_top_emails Fetch emails docs ↗ | GET /v2/onebox/top-emails | none | <1s | 5/s | no bill |
get_onebox_thread_emails get emails from a thread docs ↗ | GET /v2/onebox/thread-emails | none | <1s | 5/s | no bill |
get_onebox_search_emails Search emails docs ↗ | GET /v2/onebox/search-emails | none | <1s | 5/s | no bill |
post_onebox_send_email Send Email docs ↗ | POST /v2/onebox/send-email | external_send | 1-5s | 5/s | no bill |
post_onebox_download_attachment Download Attachment docs ↗ | POST /v2/onebox/download-attachment | crm_write | 1-5s | 5/s | no bill |
post_onebox_create_new_label Create New Label docs ↗ | POST /v2/onebox/create-new-label | crm_write | 1-5s | 5/s | no bill |
post_onebox_delete_label Delete Label docs ↗ | POST /v2/onebox/delete-label | crm_write | 1-5s | 5/s | no bill |
post_onebox_rename_label Rename Label docs ↗ | POST /v2/onebox/rename-label | crm_write | 1-5s | 5/s | no bill |