1. GWS
ResellerStack Developer API
  • Introduction
  • Quick start
  • API Reference
    • Customers
      • List customers
      • Create customer
      • Get customer
      • Update customer notes
      • Update customer status
      • Update billing details
    • Geo
      • List countries
      • List states
    • Pricing
      • List TLD pricing
      • Update TLD pricing
      • Set TLD featured
      • Apply bulk margin
      • Reorder TLD pricing
    • Domains
      • List domains
      • Check domain availability
      • Register a domain
      • Checkout domain cart (bulk)
      • Toggle WHOIS privacy
      • Update domain contacts
      • Get domain
      • Toggle transfer lock
      • Toggle auto-renew
      • Preview renewal price
      • Renew domain now
      • Register a domain with Google Workspace
      • List bundle offers for a name
      • Register a bundle
    • Contacts
      • List contacts
      • Create contact
      • Get contact
    • Orders
      • List orders
      • Get order
    • DNS
      • List DNS records
      • Add DNS records
      • Update DNS record
      • Delete DNS record
      • Update nameservers
      • Reset nameservers
      • List DNSSEC records
      • Add DNSSEC record
      • Delete DNSSEC record
    • Wallet
      • Get wallet balance
    • Webhooks
      • workspace.pastdue
      • workspace.expired
      • workspace.txt.failed
      • workspace.renewed
      • workspace.provisioned
      • workspace.txt.ready
      • workspace.txt.propagated
      • workspace.licenses.increased
      • workspace.deleted
      • workspace.failed
      • mailbox.ready
      • mailbox.deleted
      • workspace.dkim.ready
      • workspace.dkim.propagated
      • workspace.domain.swapped
      • Delivered when domain.order.success fires
      • Delivered when domain.order.failed fires
      • Delivered when domain.renewal.success fires
      • Delivered when domain.renewal.failed fires
    • GWS
      • Google Workspace ~ Creation Flow
      • Google Workspace ~ Sandbox Environment
      • Check Workspace Exists
        POST
      • Create Workspace
        POST
      • List Workspaces
        GET
      • Delete Workspace
        DELETE
      • Check DNS Propagation
        POST
      • Renew Workspace
        POST
      • Change Primary Domain (Beta)
        POST
    • Licenses & Mailboxes
      • Create Mailbox
      • List Mailboxes
      • Delete Mailboxes
      • Decrease Seats
  • Health check
    GET
  • Get current partner
    GET
  1. GWS

Create Workspace

Production
https://api.resellerstack.ai/api/v1
Production
https://api.resellerstack.ai/api/v1
POST
/gws
🧪 Sandbox only for now. This endpoint is currently available in the sandbox environment only; live access is coming soon.
Provision a new Google Workspace for a customer.
Returns 202; provisioning happens in the background. Listen to webhooks for status updates.

Request

Authorization
API Key
Add parameter in header
rs-x-api-key
Example:
rs-x-api-key: ********************
or
Body Params application/jsonRequired

Examples

Responses

🟢202Accepted
application/json
Workspace accepted and queued. Provisioning continues asynchronously - poll GET /gws.
Bodyapplication/json

🟠403Forbidden
🟠402Payment Required
🟠404Not Found
🟠409Conflict
🟠422Validation Error
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.resellerstack.ai/api/v1/gws' \
--header 'rs-x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "userId": "954e9f97-b324-4dc1-a92d-e4d38c31fb88",
    "domain": "example.com",
    "orgName": "example.com",
    "mailboxes": [
        {
            "username": "mike",
            "firstName": "Mike",
            "lastName": "Rober",
            "password": "Str0ng!Pass#1"
        }
    ],
    "collectionMethod": "MANUAL"
}'
Response Response Example
202 - Example 1
{
    "status": 202,
    "message": "Workspace queued",
    "data": {
        "domain": "example.com",
        "status": "provisioning",
        "checkoutUrl": "https://checkout.stripe.com/c/pay/cs_test_a1B2c3",
        "invoiceUrl": "https://invoice.stripe.com/i/acct_1/test_YWNj",
        "invoiceNumber": "INV-0042",
        "mailboxes": [
            {
                "email": "admin@example.com",
                "isAdmin": true,
                "status": "provisioning"
            }
        ]
    }
}
Modified at 2026-10-22 09:07:25
Previous
Check Workspace Exists
Next
List Workspaces
Built with