Add mailboxes to a domain
Orders mailboxes on a connected domain by its id: the same as POST /v1/mailboxes naming the domain. The first ones or more later, up to 10 in all. Each month is held from your wallet now and only taken once that mailbox is set up, so one that fails costs nothing. The first mailbox on a domain administers its Google account. Follow mailbox.active or poll each mailbox; then read its sign-in details from the credentials route. Send an Idempotency-Key header so a retry never orders twice.
apiKeyAuthorizationBearer <token>An API key from the Developers page. rhq_test_ keys reach the sandbox, rhq_live_ keys the live side.
id*stringIdempotency-Key?stringA value unique to this request, such as a UUID. A retry with the same key within 24 hours returns the first outcome instead of running again.
8 <= length <= 200application/json- body
mailboxes*array<>1 <= items <= 10Created
application/json- response
Created
data*array<>curl -X POST "https://example.com/v1/mailbox-domains/mdm_01K6XJ4Q8ZT3M9R5V2B7WDHNCA/mailboxes" \ -H "Idempotency-Key: 2f1c9a52-7d0e-4a8e-9a53-0c1f6f3f2b11" \ -H "Content-Type: application/json" \ -d '{ "mailboxes": [ { "username": "jo", "firstName": "Jo", "lastName": "Bloggs" } ] }'{ "data": [ { "id": "mbx_01K6XJ4Q8ZT3M9R5V2B7WDHNCA", "mailboxDomainId": "mdm_01K6XJ4Q8ZT3M9R5V2B7WDHNCA", "email": "[email protected]", "username": "jo", "firstName": "Jo", "lastName": "Bloggs", "profilePictureUrl": "string", "isAdmin": true, "status": "queued", "setupStage": "configuring_dns", "failure": { "code": "DOMAIN_IN_USE_GOOGLE", "message": "Domain is already in use in Google Workspace." }, "customerId": "cus_01K6XJ4Q8ZT3M9R5V2B7WDHNCA", "activatedAt": "2026-10-07T11:04:31.000Z", "actor": { "kind": "user", "label": "string" }, "createdAt": "2026-10-07T11:04:31.000Z" } ]}Regenerate nameservers POST
A fresh set of nameservers for a domain that is `failed` or still waiting. Set the new ones at the registrar (a domain held here is changed for you).
Invite a sub-reseller POST
Mails a single-use link that lets the invitee sign up as a reseller of their own, priced from the given list (unset, your default list). One level deep: an account that is itself a sub-reseller cannot invite another.