Restore a workspace

Re-activate an archived workspace with an organisation key: its allocation or plan comes back and its keys authenticate again.

Shared-pool organisations: the workspace returns with its previous allocation. Separate-workspace organisations: its plan resumes while the paid period still runs, otherwise it returns on the Free plan — unless the organisation already holds a Free workspace (403 free_plan_workspace_limit; restore it with a plan from the console).

POST /v3/organisation/workspaces/{id}/restore

Body parameters

Parameter	Type	Required	Description
`plan_action`	string	Optional	Separate-workspace organisations only: `resume` the archived plan while its paid period still runs, or restore on `free`. Omit to resume when possible, else Free. The body may be empty.

Response (200)

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
`200`	OK. The workspace, active again.
`400`	The workspace is not archived, or `resume` was asked for a plan that has lapsed.
`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`.
`404`	No workspace with this id in your organisation (ids of other organisations are never revealed).

Code examples

cURL

curl -X POST https://api.wemail.io/v3/organisation/workspaces/9d2f6c1e-4b3a-4e7d-8a1f-0c5b7e9d2a64/restore \
  -H "Authorization: Bearer afn_org_…" \
  -H "Content-Type: application/json" \
  -d '{
    "plan_action": "resume"
  }'

Node.js

const res = await fetch("https://api.wemail.io/v3/organisation/workspaces/9d2f6c1e-4b3a-4e7d-8a1f-0c5b7e9d2a64/restore", {
  method: "POST",
  headers: { Authorization: "Bearer " + process.env.WEMAIL_ORG_KEY, "Content-Type": "application/json" },
  body: JSON.stringify({"plan_action": "resume"}),
});
console.log(await res.json());

Python

import os, requests

res = requests.post(
    "https://api.wemail.io/v3/organisation/workspaces/9d2f6c1e-4b3a-4e7d-8a1f-0c5b7e9d2a64/restore",
    headers={"Authorization": "Bearer " + os.environ["WEMAIL_ORG_KEY"]},
    json={"plan_action": "resume"},
)
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"
}