Create a workspace

Creates a sub-workspace under the API key's main workspace and, by default, mints a read+write API key bound to the new workspace. The key's fullKey is returned exactly once and cannot be retrieved again, and it never outlives the caller: when the calling key has an expiry, the minted key carries the same expiresAt. Must be called with a main workspace's key: keys bound to sub-workspaces are refused. API keys are included in every plan; workspaces are a Professional-plan feature.

post/workspaces

Request

Base URL: https://api.emailchaser.com/r
URL: https://api.emailchaser.com/r/workspaces
Auth: HTTP bearer

Request body

generateApiKeyboolean

GenerateApiKey mints a read+write API key bound to the new workspace. Defaults to true; pass false to create the workspace only.

namestring required

Name of the new workspace. Trimmed; 1-60 characters.

Example request

{
  "generateApiKey": true,
  "name": "Acme Outbound"
}

Response

The created workspace and its API key

notestring

Note reminds integrators that fullKey is not retrievable later.

Example response

{
  "apiKey": {
    "expiresAt": "2026-09-07T12:00:00Z",
    "fullKey": "run_abc12345_...",
    "id": 12,
    "name": "Acme Outbound key",
    "scopes": [
      "read",
      "read_write"
    ]
  },
  "note": "Store apiKey.fullKey now: it cannot be retrieved again.",
  "workspace": {
    "createdAt": "2026-08-19T10:30:00Z",
    "iconUrl": "https://whitelabel-assets.emailchaser.com/workspace-icons/51539607552/1766000000-a1b2c3d4e5f6.png",
    "id": 51539607552,
    "name": "Acme Outbound"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.