Domain Management

Every mailbox lives on a domain. You can buy new domains through InboxKit or connect domains you already own. This page lists what you can do with domains and which endpoint to use for each task.

Most domain endpoints need the X-Workspace-Id header. Each endpoint page lists the headers it needs. New to the API? Start with the Quick Start.

Buy a new domain

Task	Endpoint
Find available names for a keyword	Search available domains
Check a single name and its price	Check domain availability
Check a name for blocked keywords	Check if domain is banned from registration
Check whether names can be used with Google Workspace or Microsoft 365	Check Workspace Availability
Buy one or more domains	Register domains
Buy domains and create their mailboxes in one request	Place Order

Connect a domain you already own

By changing nameservers

Add the domain and get its nameservers with Get nameservers for domain connection.

Replace the nameservers at the company where you bought the domain.

Track the change with Check nameservers propagation.

If the new nameservers are not picked up within 24 hours, the domain's status changes to expired_propagation. Get fresh nameservers with Regenerate Domain Nameservers. Use the same endpoint if your nameservers were later changed at the company where you bought the domain.

From your own Cloudflare account

Task	Endpoint
Connect domains with your Cloudflare credentials	Connect Cloudflare Domains
See the other zones in your Cloudflare account (after your first connect)	List Cloudflare Zones
List connected domains	List Connected Cloudflare Domains
Get one connected domain	Get Domain Details
Disconnect domains	Disconnect Cloudflare Domains

See your domains

Task	Endpoint
List domains with filters and status	List domains
List domains you can add mailboxes to	List assignable domains

A domain can host mailboxes once its status is active. To be told when that happens, use the domain.status_changed webhook event.

Configure a domain

Task	Endpoint
Send visitors to your website, with or without URL masking	Set domain forwarding
Send mail for unknown addresses on the domain to one inbox	Set catch-all email, Remove catch-all email
Set your own DMARC policy	Set DMARC Configuration, Remove DMARC Configuration
Group domains with tags	Assign tags to domains or mailboxes

URL masking shows your website under the domain instead of redirecting to it. Before you can mask to a website, prove you own it:

Add a destination to verify.

Publish the TXT record from the response at your DNS provider.

Verify a destination.

You can see and remove your websites with List verified destinations and Remove a destination.

Manage DNS records

Task	Endpoint
See a domain's records	Get DNS records
Add, change or delete records	Add DNS records, Update DNS records, Delete DNS records
Check MX, SPF, DKIM and DMARC	Verify DNS records
Fix missing or wrong email records	Repair DNS records

Renewals and ownership details

These apply to domains you bought through InboxKit.

Task	Endpoint
Renew domains	Request Domain Renewal
Check renewal status	Check Renewal Status
Turn WHOIS privacy on or off	Update Domain Privacy
Change the WHOIS contact details	Update Domain Contact Details

Remove domains

To remove domains from your workspace, use Remove domains.

Domain Management

Buy a new domain#

Connect a domain you already own#

See your domains#

Configure a domain#

Manage DNS records#

Renewals and ownership details#