Create a workspace

Create an isolated workspace for a customer or team by code — with its own future domains, keys and suppressions, and a monthly allocation from your organisation pool.

The new workspace starts with bounce and complaint suppressions shared from your home workspace, no domains and no keys — mint its first key with Create a workspace API key. In a separate-workspace organisation (each workspace on its own plan) this endpoint can mint one Free workspace; further workspaces need a plan chosen in the console and the call returns 403 free_plan_workspace_limit.

POST /v3/organisation/workspaces

Body parameters

Parameter	Type	Required	Description
`name`	string	Required	Workspace name, 1–80 characters. Shown to its members.
`timezone`	string	Optional	IANA timezone for reports and scheduling.
`default_language`	string	Optional	Default content language.
`monthly_allocation`	integer	Optional	Shared-pool organisations only: emails per month allocated from the organisation pool, clamped to the unallocated remainder. Change it later with Update workspace limits.

Response (201)

json

{
  "id": "9d2f6c1e-4b3a-4e7d-8a1f-0c5b7e9d2a64",
  "name": "Acme EU",
  "slug": "acme-eu",
  "status": "active",
  "home": false,
  "plan": "professional",
  "timezone": "Europe/Athens",
  "default_language": "en",
  "created_at": "2026-10-29T10:00:00Z"
}

Responses

Status	Description
`201`	Created. The new workspace.
`400`	Validation error.
`401`	Missing or invalid organisation key — workspace keys (`afn_live_` / `afn_test_`) are refused here by design.
`403`	`insufficient_scope` — the key lacks `workspaces:write` — or `ip_not_allowed`. Or `free_plan_workspace_limit`.

Code examples

cURL

curl -X POST https://api.wemail.io/v3/organisation/workspaces \
  -H "Authorization: Bearer afn_org_…" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Acme EU",
    "timezone": "Europe/Athens",
    "default_language": "en",
    "monthly_allocation": 50000
  }'

Node.js

const res = await fetch("https://api.wemail.io/v3/organisation/workspaces", {
  method: "POST",
  headers: { Authorization: "Bearer " + process.env.WEMAIL_ORG_KEY, "Content-Type": "application/json" },
  body: JSON.stringify({"name": "Acme EU", "timezone": "Europe/Athens", "default_language": "en", "monthly_allocation": 50000}),
});
console.log(await res.json());

Python

import os, requests

res = requests.post(
    "https://api.wemail.io/v3/organisation/workspaces",
    headers={"Authorization": "Bearer " + os.environ["WEMAIL_ORG_KEY"]},
    json={"name": "Acme EU", "timezone": "Europe/Athens", "default_language": "en", "monthly_allocation": 50000},
)
print(res.json())

ResponseExample response

{
  "id": "9d2f6c1e-4b3a-4e7d-8a1f-0c5b7e9d2a64",
  "name": "Acme EU",
  "slug": "acme-eu",
  "status": "active",
  "home": false,
  "plan": "professional",
  "timezone": "Europe/Athens",
  "default_language": "en",
  "created_at": "2026-10-29T10:00:00Z"
}