clientspace
Manage clientspaces (whitelabel sub-organizations) under your agency account. Each clientspace has isolated data and its own API key. The apiKey field is server-redacted from all responses — see schemas/clientspace. To run operations on behalf of a clientspace, see clientspace-delegation.
Plan required. Creating clientspaces requires a Clientspace/whitelabel plan. The plan gate returns
403 PLAN_REQUIREDplus an upgrade URL. Required-field validation runs before the plan gate — a missingtitleis rejected with400 MCP_VALIDATION_FAILEDbefore any upstream call, so it never reaches the 403. Do not re-authenticate; upgrade the plan.
Need isolated client accounts without whitelabeling? Workspaces are available on every plan — see workspace-delegation.
The choice is one-way: no operation converts a workspace into a clientspace or back, so decide per client up front — switching later means re-creating that client's data under the other type. Either type is reached through its own server-resolved API key, not through a client login.
Operations
Read
- clientspace/get — List all clientspaces
- clientspace/get_by_id — Get a clientspace by ID
- clientspace/get_credits_by_id — Get a clientspace's sending-credit balance
Create
- clientspace/post — Create a clientspace
- clientspace/post_credits_by_id — Allocate sending credits to a clientspace
Update
- clientspace/patch_by_id — Update a clientspace
Delete
- clientspace/delete_by_id — Delete a clientspace