Documentation
Sign inGet started
立即开始
指南
API 参考
SDK
CLI
知识库
更新日志

Workspaces

The workspace is the unit of work in Bird: where domains are verified, API keys are minted, email is sent, and your team has access. The dashboard is workspace-first, and everything you do happens inside one.
Above the workspace sits an organization, the account layer that holds billing and the region. Each organization has one workspace, and the two are created together at signup, so the organization rarely needs thinking about. It matters when you go looking for something the workspace doesn't own:
LevelWhat lives there
OrganizationMembers and invitations, billing, plan, and the wallet, dedicated IPs and IP pools, region
WorkspaceAPI keys, the team and its roles, sending domains, emails, suppressions, webhooks

Regions

Every organization is pinned to exactly one region, currently us1 (United States) or eu1 (European Union). The region is chosen when the organization is created and cannot be changed: its data and sending infrastructure live there, and its API traffic goes to that region's host, https://us1.platform.bird.com or https://eu1.platform.bird.com. The region is baked into every API key prefix (bk_us1_...), so requests route themselves. See Base URLs & regions for the routing rules and what happens to a request that reaches the wrong region.

How a request finds its workspace

Bird's API uses flat routes (/v1/email/messages, /v1/members) with no organization or workspace segment in the path. The credential carries the context instead: an API key is bound to one workspace, which fixes its organization and its region too, so a request needs nothing beyond the key itself. A request that names a context contradicting its key is rejected as malformed (400) rather than silently reinterpreted.
Whether the request is then allowed is a separate question, answered by key scopes for API keys and by roles for people working in the dashboard.

Closing an account

The workspace exists for the lifetime of the organization and can't be removed on its own. Closing the organization is how you delete everything, and it's deliberately hard to do by accident and recoverable for a while:
  • Only the owner can start it, and starting it deletes nothing. The organization owner requests closure under Settings → Organization, and Bird emails a confirmation link. Until someone follows that link, nothing changes.
  • Lockout is immediate on confirmation. The organization disappears from the dashboard, its API keys stop authenticating and are revoked, sending stops, and any active subscription is canceled so a closing account stops accruing renewal charges.
  • A 7-day grace window follows. Data, configuration, and team memberships are retained untouched. The closure email carries a cancel link, and following it inside the window restores access. Everything comes back except API keys, which were revoked at lockout and have to be re-issued.
  • Then the purge is irreversible. After the window, cleanup runs and reclaims everything: domains, suppressions, webhook endpoints, templates, memberships, data. Nothing can be recovered once the purge begins.

Next steps