Check domains for mailboxes
Before ordering on several domains at once: whether each is connected here already (and how many more mailboxes it takes), held here, free to buy (and at what price), registered elsewhere, or cannot have mailboxes, such as one already used with Google Workspace elsewhere. registrant says whether a domain bought with the order has someone to be registered to.
apiKeyAuthorizationBearer <token>An API key from the Developers page. rhq_test_ keys reach the sandbox, rhq_live_ keys the live side.
application/json- body
domains*array<>1 <= items <= 50customerId?stringSuccess
application/json- response
Success
data*array<>registrant*|Who a domain bought for the customer is registered to: the customer's own registrant, or your default one. Null when there is neither, so none can be bought
curl -X POST "https://example.com/v1/mailbox-domains/check" \ -H "Content-Type: application/json" \ -d '{ "domains": [ "northwind-mail.com", "northwind-hq.com" ] }'{ "data": [ { "domain": "northwind-mail.com", "state": "connected", "room": 0, "mailboxDomainId": "mdm_01K6XJ4Q8ZT3M9R5V2B7WDHNCA", "domainId": "dom_01K6XJ4Q8ZT3M9R5V2B7WDHNCA", "dnsElsewhere": true, "registered": true, "price": 450, "customerPrice": 450, "reason": { "code": "DOMAIN_IN_USE_GOOGLE", "message": "Domain is already in use in Google Workspace." } } ], "registrant": "customer"}List OAuth client IDs GET
Previous Page
Connect a domain POST
Connects a domain without ordering anything, for when you want its nameservers before you buy: most often a domain registered elsewhere, so they can be set at its registrar ahead of time. Not needed otherwise: ordering mailboxes connects the domain by itself. Free.