workspace

Manage workspaces (sub-organizations) under your agency account. Each workspace has isolated data (campaigns, prospects, senders) and its own API key. The apiKey field is server-redacted from all responses — see schemas/workspace. To run operations on behalf of a workspace, see workspace-delegation.

Agency-only. Workspace operations are rejected when called from a workspace account itself.

Operations

Read

• workspace/get — List all workspaces
• workspace/get_by_id — Get a workspace by ID
• workspace/get_credits_by_id — Get a workspace's sending-credit balance

Create

• workspace/post — Create a new workspace
• workspace/post_credits_by_id — Allocate sending credits to a workspace

Update

• workspace/patch_by_id — Update a workspace

Delete

• workspace/delete_by_id — Delete a workspace (two-phase: immediate removal, background data purge)