Set website forwarding
Redirects the domain's website to a URL. url: null removes the redirect.
apiKeyAuthorizationBearer <token>An API key from the Developers page. rhq_test_ keys reach the sandbox, rhq_live_ keys the live side.
id*stringapplication/json- body
url*|nullcaptcha?booleanShow a captcha before redirecting
Success
application/json- response
Success
id*stringdomain*stringstatus*stringawaiting_domain while a domain bought with the order is still being registered; awaiting_nameservers until the domain points at nameservers; propagating once we have pointed a domain held here ourselves; active when mailboxes can be set up on it; failed when it never pointed there in time (regenerate the nameservers and try again); deleting then deleted once you delete it
"awaiting_domain""awaiting_nameservers""propagating""active""failed""deleting""deleted"source*stringresellerhq for a domain you hold here, whose nameservers we change for you; external for one registered elsewhere, whose nameservers you change at its registrar
"resellerhq""external"domainId*|The domain held here, for resellerhq
nameserversManaged*booleanTrue when we point the domain at nameservers ourselves (a domain held here): there is nothing for you to do. False when you set them at its registrar
nameservers*array<string>Where the domain must point. Its DNS is hosted there from then on
failure*|Why the domain is failed
customerId*string|nullunitPrice*integerWhat you pay per mailbox per month on this domain, fixed when it was connected
0 <= valuecustomerPrice*|What the customer pays per mailbox, when fixed here
periodEndsAt*|When the month paid for ends. Every set-up mailbox on the domain renews together then. Null until the first mailbox is ordered
unpaidSince*|When the renewal now due first could not be charged. Null when nothing is owed
deletesAt*|When an unpaid domain is deleted with its mailboxes. Add funds before then
forwarding*|Where the domain's website redirects
dmarc*|nullactor*|Who did it; null for anything done before we recorded that
createdAt*stringdate-timecurl -X PUT "https://example.com/v1/mailbox-domains/mdm_01K6XJ4Q8ZT3M9R5V2B7WDHNCA/forwarding" \ -H "Content-Type: application/json" \ -d '{ "url": "https://northwind.com" }'{ "id": "mdm_01K6XJ4Q8ZT3M9R5V2B7WDHNCA", "domain": "northwind-mail.com", "status": "awaiting_domain", "source": "resellerhq", "domainId": "dom_01K6XJ4Q8ZT3M9R5V2B7WDHNCA", "nameserversManaged": true, "nameservers": [ "ns1.example-dns.net" ], "failure": { "code": "DOMAIN_IN_USE_GOOGLE", "message": "Domain is already in use in Google Workspace." }, "customerId": "cus_01K6XJ4Q8ZT3M9R5V2B7WDHNCA", "unitPrice": 450, "customerPrice": 450, "periodEndsAt": "2026-10-07T11:04:31.000Z", "unpaidSince": "2026-10-07T11:04:31.000Z", "deletesAt": "2026-10-07T11:04:31.000Z", "forwarding": { "url": "https://northwind.com", "captcha": true }, "dmarc": { "reportingEmail": "string", "policy": "none", "subdomainPolicy": "none", "percentage": 0 }, "actor": { "kind": "user", "label": "string" }, "createdAt": "2026-10-07T11:04:31.000Z"}