rs_test_*) against the sandbox base URL. Keys are issued per partner, and you pass yours in the rs-x-api-key header exactly like a live key.| Method | Path | Notes |
|---|---|---|
POST | /gws | Create workspace. The domain prefix controls the behaviour. |
GET | /gws | List workspaces (sandbox rows only) |
DELETE | /gws | Delete workspace |
POST | /gws/renew | Renew workspace |
POST | /gws/primary-domain | Beta. Swap the workspace's primary domain. Emits the swap webhooks; advance external-DNS with dns-propagation-checks. |
POST | /create-mailbox | Add mailboxes to an active workspace |
GET | /mailboxes | List mailboxes |
DELETE | /mailboxes | Delete mailboxes |
POST | /mailboxes/reset-password | Returns a fabricated password synchronously |
POST | /decrease-seat | Decrease seats |
POST | /dns-propagation-checks | Advance propagation on external-DNS workspaces |
POST /gws decides which case the sandbox simulates.rs-dns-example.com triggers the RS DNS flow.| Prefix | Simulates | What you need to do after POST /gws |
|---|---|---|
rs-dns- | Domain registered through Reseller Stack (POST /domain/register), so we manage DNS | Nothing. We write the verification and DKIM records and the workspace provisions end to end. |
external-dns- or any unrecognized prefix | Customer brought their own domain from a third-party registrar, so they manage DNS | Call POST /dns-propagation-checks twice: once after the verification TXT record is generated, and once after the DKIM record is generated. |
rs-dns-)POST /gws, you only receive webhooks; there's nothing to call.external-dns-)POST /dns-propagation-checks to confirm the record is live, then continues. This happens once for the verification TXT record and once for the DKIM record.rs-dns- prefix exactly.| Prefix | Behaviour |
|---|---|
rs-dns- | RS DNS path. Every stage auto-advances, no dns-propagation-checks calls needed. |
external-dns- | External DNS path. Pauses after txt_ready and after dkim_ready; resume each with POST /dns-propagation-checks. |
gws-fail- | Terminal failure. The workspace is accepted (202) then driven straight to status: failed, emitting workspace.failed. |
| (anything else) | Treated as external DNS, same as external-dns-. |
rs-dns-example.com -> auto-completes in ~50s, no DNS calls
external-dns-example.com -> pauses twice; you drive each gate
example.com -> same as external-dns-example.com
gws-fail-example.com -> fails immediatelyrs-dns-*)workspace.provisioned, workspace.txt.propagated, workspace.dkim.propagated, then mailbox.ready per mailbox once the mailboxes activate. The *.ready events never fire here - nothing for the partner to act on.external-dns-* or any other prefix)txt_ready and after dkim_ready. Resume each one with POST /dns-propagation-checks: purpose: domain_verification for the first gate, purpose: dkim for the second. Everything else auto-advances on the usual 10-second hops.workspace.provisioned, workspace.txt.ready, (gate), workspace.txt.propagated, workspace.dkim.ready, (gate), workspace.dkim.propagated, mailbox.ready per mailbox.gws-fail-*)status: failed in under a second. You get one webhook: workspace.failed.| Stage | Delay |
|---|---|
provisioned | 0s (immediate) |
txt_ready | +10s |
txt_propagated | +10s |
dkim_ready | +10s |
dkim_propagated | +10s |
activate_mailboxes | +10s |
delete_mailboxes | +10s |
delete_workspace | +10s |
increase (add mailboxes) | 0s (immediate) |
rs-dns-. The workspace activates in ~50s with no DNS-check calls.workspace.provisioned > workspace.txt.propagated > workspace.dkim.propagated > mailbox.ready (x N)external-dns- or any other prefix. The simulator pauses at two points:POST /dns-propagation-checks with purpose: domain_verification to advance to in_progress.POST /dns-propagation-checks with purpose: dkim to advance to active.workspace.provisioned > workspace.txt.ready > (pause) > workspace.txt.propagated > workspace.dkim.ready > (pause) > workspace.dkim.propagated > mailbox.ready (x N)workspace.provisionedfires once, at the start. There is no second event at mailbox activation;mailbox.ready(one per mailbox) is the signal that provisioning is done.
gws-fail-. The request is accepted (202), then the workspace is immediately driven to status: failed.workspace.failed409.422.POST /create-mailbox on an active workspace. New mailboxes activate immediately (0s delay).workspace.licenses.increased, mailbox.ready (x N new mailboxes)409.DELETE /mailboxes. The mailbox moves to deleting, and the row is deleted ~10s later.mailbox.deleted (x N)409.404.POST /mailboxes/reset-password returns a fabricated password synchronously. No webhook.POST /decrease-seat decrements totalMailboxQuantity. No Google entitlement call is made.POST /dns-propagation-checks with purpose: domain_verification advances from txt_verification_pending and enqueues txt_propagated (fires ~10s later).{ "status": "verification_queued", "allPropagated": false }POST /dns-propagation-checks with purpose: dkim advances from in_progress and enqueues dkim_propagated (fires ~10s later).{ "status": "verification_queued", "allPropagated": false }POST /gws/renew resets the subscription to active and extends currentPeriodEnd.workspace.renewedDELETE /gws queues deletion. Mailboxes are deleted ~10s later, then the workspace is soft-deleted ~10s after that (~20s total).mailbox.deleted (x N), workspace.deletedBeta. POST /gws/primary-domainis in beta and available in the sandbox only; its behaviour may change.
new_domain to the workspace's primary domain and migrates the old domain's mailboxes across. Billing doesn't move.POST /gws/primary-domain{
"userId": "b3d6f2a1-4c8e-4f9d-a2b1-7e3d5c9f0a12",
"current_domain": "example.com",
"new_domain": "example.org"
}202 with { "swapId": "d81c7a2e-9b3f-4a6c-8e21-5f0b2c7d1a93", "status": "QUEUED" }, then the swap runs in the background.new_domain has to already be a sandbox Google domain owned by the same userId, and it has to differ from current_domain.new_domain, not re-charged.new_domain as IN_PROGRESS and flip to ACTIVE once DKIM propagates.for_primary_domain_swap: true, so you can route swap events separately.new_domain prefix, same rule as POST /gws:| Prefix | DNS | Behaviour |
|---|---|---|
rs-dns-… | Platform-managed | Fully automatic. Each stage fires ~10s after the previous, and there are no *.ready webhooks because there's nothing for you to add. |
external-dns-… | You manage | Pauses twice. Add each record, then resume with POST /dns-propagation-checks. |
rs-dns-*)external-dns-*)new_domain is rs-dns-…)| Time | What happens | Webhooks fired |
|---|---|---|
T+0s | 202 returned; verification TXT written | (none) |
~T+10s | TXT propagated; subscription and workspace remapped to new_domain | workspace.txt.propagated, workspace.domain.swapped |
~T+20s | DKIM record written | (none) |
~T+30s | DKIM propagated; new mailboxes activated | workspace.dkim.propagated, mailbox.ready (x N) |
new_domain is external-dns-…)POST /dns-propagation-checks.| Step | Trigger | Webhooks fired |
|---|---|---|
| 1 | 202 returned; verification TXT generated | workspace.txt.ready (carries the TXT record) |
| 2 | You add the TXT, then POST /dns-propagation-checks { purpose: "domain_verification" } | (queued) |
| 3 | ~10s later: TXT propagated; subscription and workspace remapped | workspace.txt.propagated, workspace.domain.swapped |
| 4 | ~10s later, automatic: DKIM record generated | workspace.dkim.ready (carries the DKIM record) |
| 5 | You add the DKIM, then POST /dns-propagation-checks { purpose: "dkim" } | (queued) |
| 6 | ~10s later: DKIM propagated; new mailboxes activated | workspace.dkim.propagated, mailbox.ready (x N) |
workspace.domain.swappedis the moment the primary domain actually changes in the DB. From there the subscription, workspace, and new mailbox rows all point atnew_domain. The new mailboxes stayIN_PROGRESSuntilworkspace.dkim.propagated, when they flip toACTIVEand each firesmailbox.ready.