acme) or a full name (acme.com) to get availability and prices. Supported TLDs are com, net, org, biz, live, info and co. To check a shortlist of up to 20 exact names, use Check Availability of Multiple Domains. To have names suggested from keywords, use Find Domains With AI and call it repeatedly with the same body until status is completed; results are cached for 5 minutes.years for each. The response contains a payment link in invoiceLink, not the standard status and data fields. Unpaid reservations are discarded after about 5 minutes, so pay the link promptly. With useWallet set to true your wallet balance is applied first and any remainder is billed on the invoice.status ACTIVE. A domain that cannot be registered after payment is refunded.redirect, and a listed domain can still be refused at purchase if it is not in the latest batch. This charges your wallet in the same way as Buy Domains. For pre-warmed domains see Pre-Warmed.domainNames. The first call returns status: pending and starts background jobs. Subdomains, invalid names and names that are already connected are reported as FAILED without a reason.CHECKING_NS_IN_WHOIS and its metadata.expectedNameservers lists the nameservers to set at your registrar.status: completed once every name has a final status. Zapmail re-checks with increasing delays for up to 36 hours, then ends the request as NS_NOT_CHANGED.domainNames there removes every request in the workspace that matches your filters, or all of them when you send none.nameServers is one comma-separated string. With maskForwarding set to true you get the ClouDNS nameservers (zapmaildns.com); otherwise you get the Cloudflare nameservers assigned to the domain's zone.expectedNameServers and gotNameServers; retry later. This call does not add a domain that is not already in the workspace, so use Connect Domains to add one.domainsMatched in the response with the number of IDs you sent.| Task | Endpoint |
|---|---|
| Read every record in a domain's zone | Get DNS Records |
| Add records to one domain | Add DNS Records |
| Add the same records to many domains | POST /dns/bulk |
| Change one record | Update DNS Record |
| Delete one record | Delete DNS Record |
| Check SPF, DMARC, DKIM and MX | Check DNS Records |
id and zone_id from Get DNS Records for update and delete calls.domainIds, domains are chosen from tagIds, status and contains, and with none of those from every domain in the workspace.domainIds checks every domain in the workspace and lists every checked domain, not only the failing ones.domainIds (required).| Setting | What it does | Remove it |
|---|---|---|
dmarc.email | Adds a DMARC record to the domain's DNS using this address as the DMARC contact for reports. | Cannot be removed with this endpoint. |
forwarding.url | Domain forwarding: visitors to the domain are forwarded to this URL. A value without :// gets https:// prepended. URLs containing linkedin are rejected with 400. | Send null for url. |
emailForwarding.email | Email forwarding: mail for the domain is forwarded to this address. | Send null for email. |
catchAll.email | Catch-all: mail sent to any address on the domain that has no mailbox is delivered to this address. | Send null for email. |
checkDns | When true, runs a live SPF, DMARC, DKIM and MX check and returns it as dnsStatus. | Not applicable. |
dmarc, forwarding, emailForwarding, catchAll or checkDns: true, otherwise the call returns 422. checkDns: false counts as not provided.forwarding.maskForwarding, contains, status and tagIds are accepted but have no effect. The email fields are checked only for type, not for address format, so validate them before sending.domainsMatched in the response with the number of IDs you sent. If none match, the call returns 400.tagIds).POST /domains/tags/remove. An empty tagIds detaches all tags from the selected domains, and an empty domainIds with no other selector selects every domain in the workspace, so check the selection before sending.POST /domains/tags/delete. It returns 200 even for an unknown tag ID.GET /domains/renewal-soon (or Search Domains Due for Renewal with a body) lists domains expiring within 2 months or expired within the last 7 days. Listing a domain does not mean it can be renewed: renewal needs a domain bought through Zapmail.paymentLink. Your wallet balance is applied first and the rest is payable at the link. The registrar renewal is processed after the invoice is paid. The listed domains are marked as renewing immediately, so repeating the call returns 400 for them.global to true to search every workspace the key owner belongs to.GET /global/mailbox-domain-search searches mailboxes and domains across every workspace the key owner belongs to. It ignores x-workspace-key.page (default 1) and limit (default 10). The name of the total-count field differs between endpoints, so read the response schema of the endpoint you call.