Platform Email API

Create a workspace

Provision a partner-managed workspace, its domain, and initial mailboxes with a platform credential.

First request

curl -X POST https://m.venmail.io/api/v1/platform/email/workspaces \
  -H "Authorization: Bearer <platform_credential>" \
  -H "Idempotency-Key: workspace-customer-123" \
  -H "Content-Type: application/json" \
  -d '{
    "external_id": "customer_123",
    "organization": {
      "name": "Acme Stores",
      "domain": "acmestores.example"
    }
  }'

Authentication Platform bearer credentials, not a user JWT.

Safe retries Reuse an Idempotency-Key for the same write operation.

Rate limits 120 reads/minute · 30 writes/minute.

Loading API documentation...