1. Licenses & Mailboxes
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
      • Create Workspace
      • List Workspaces
      • Delete Workspace
      • Check DNS Propagation
      • Renew Workspace
      • Change Primary Domain (Beta)
    • Licenses & Mailboxes
      • Create Mailbox
        POST
      • List Mailboxes
        GET
      • Delete Mailboxes
        DELETE
      • Decrease Seats
        POST
  • Health check
    GET
  • Get current partner
    GET
  1. Licenses & Mailboxes

Create Mailbox

Production
https://api.resellerstack.ai/api/v1
Production
https://api.resellerstack.ai/api/v1
POST
/create-mailbox
๐Ÿงช Sandbox only for now. This endpoint is currently available in the sandbox environment only; live access is coming soon.
Buy additional seats and create the mailboxes on them.
Each entry in mailboxes buys one new seat and creates one mailbox. Seat purchase is confirmed synchronously; the actual mailbox creation processes in the background.
Prerequisites: the workspace must be active and the admin mailbox must be active. A past_due workspace is rejected with 409; renew it first with POST /gws/renew.
Scope: mailboxes:write

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
Seats purchased and mailbox creation processing. Each mailbox's provisioning status is tracked via GET /gws.
Bodyapplication/json

๐ŸŸ 403Forbidden
๐ŸŸ 402Payment Required
๐ŸŸ 404Not Found
๐ŸŸ 404Not Found โ€” Customer Not Found
๐ŸŸ 409Conflict
๐ŸŸ 409Conflict โ€” Subscription Not Active
๐ŸŸ 409Conflict โ€” Workspace Not Active
๐ŸŸ 409Conflict โ€” Seat Cap Reached
๐ŸŸ 422Validation Error
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.resellerstack.ai/api/v1/create-mailbox' \
--header 'rs-x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "domain": "example.com",
    "mailboxes": [
        {
            "username": "alice",
            "firstName": "Alice",
            "lastName": "Smith",
            "password": "Str0ng!Pass#2024"
        }
    ],
    "collectionMethod": "MANUAL",
    "paymentReference": "order-9871"
}'
Response Response Example
202 - Example 1
{
    "status": 202,
    "message": "Seats and mailboxes queued",
    "data": {
        "domain": "example.com",
        "status": "provisioning",
        "invoiceUrl": null,
        "invoiceNumber": null,
        "mailboxes": [
            {
                "email": "alice@example.com",
                "isAdmin": false,
                "status": "provisioning"
            }
        ],
        "checkoutUrl": null
    }
}
Modified atย 2026-10-22 09:07:25
Previous
Change Primary Domain (Beta)
Next
List Mailboxes
Built with