Create a workspace

POST

/v1/organization/workspaces

const workspace = await bird.organization.workspaces.create({
  name: "Staging",
});
console.log(workspace.id);

workspace = client.organization.workspaces.create(name="Staging")
print(workspace.id)

workspace, err := client.Organization.Workspaces.Create(context.Background(), bird.OrganizationWorkspacesCreateParams{Name: "Staging"})
if err != nil {
	log.Fatal(err)
}
fmt.Println(workspace.Id)

$workspace = $bird->organization->workspaces->create((new WorkspaceCreate())->setName('Staging'));
echo $workspace->getId() . PHP_EOL;

bird organization workspaces create Production

curl -X POST "https://us1.platform.bird.com/v1/organization/workspaces" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Production"
  }'

Response201

{
  "id": "ws_01krdgeqcxet5s7t44vh8rt9mg",
  "organization_id": "org_01krdgeqcxet5s7t44vh8rt9mg",
  "name": "Production",
  "notification_emails": {
    "operational": [
      "alerts@example.com"
    ]
  },
  "suspended_at": null,
  "created_at": "2026-05-20T09:14:52Z",
  "updated_at": "2026-05-25T16:42:01Z"
}

Creates a workspace in the caller's organization. The caller needs organization workspace write access, which organization master keys and signed-in organization owners and administrators have, as do CLI or MCP access tokens they authorize with that access. Workspace API keys cannot create workspaces. The organization's workspace limit counts every workspace it holds, including workspaces awaiting permanent deletion, and a request beyond the limit fails with E10014.

Request Payload

name

string

required

Must include at least one letter or number.

Response Payload

id

string

required

organization_id

string

required

name

string

required

notification_emails

object

required

Show child attributes

logo_url

nullable string

HTTPS URL to the current workspace logo. null when unset.

suspended_at

nullable string

When Bird suspended the workspace. null while the workspace is active. A suspended workspace cannot send messages, place calls other than emergency calls, or buy numbers or eSIMs. Its members can still sign in, read it and change its configuration.

created_at

string

required

updated_at

string

required

Continue with the documentation, guides and examples for this topic.

Get an implementation brief

const workspace = await bird.organization.workspaces.create({
  name: "Staging",
});
console.log(workspace.id);

workspace = client.organization.workspaces.create(name="Staging")
print(workspace.id)

workspace, err := client.Organization.Workspaces.Create(context.Background(), bird.OrganizationWorkspacesCreateParams{Name: "Staging"})
if err != nil {
	log.Fatal(err)
}
fmt.Println(workspace.Id)

$workspace = $bird->organization->workspaces->create((new WorkspaceCreate())->setName('Staging'));
echo $workspace->getId() . PHP_EOL;

bird organization workspaces create Production

curl -X POST "https://us1.platform.bird.com/v1/organization/workspaces" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Production"
  }'

Response201

{
  "id": "ws_01krdgeqcxet5s7t44vh8rt9mg",
  "organization_id": "org_01krdgeqcxet5s7t44vh8rt9mg",
  "name": "Production",
  "notification_emails": {
    "operational": [
      "alerts@example.com"
    ]
  },
  "suspended_at": null,
  "created_at": "2026-05-20T09:14:52Z",
  "updated_at": "2026-05-25T16:42:01Z"
}

Create a workspace

Request Payload

Response Payload

Related resources