---
title: "Create a ring group"
canonical: "https://bird.com/docs/api/reference/create-voice-ring-group"
---

# Create a ring group

`POST /v1/voice/ring-groups`

Creates a ring group with no members. Add members with
`POST /v1/voice/ring-groups/{ring_group_id}/members`.

A workspace can have at most 50 ring groups besides its default group.
Creating another returns `422`.

Ring groups require preview access to inbound browser calling. Without it,
this returns `404 Not Found`.

## Servers

- `https://{region}.platform.bird.com`: Regional API endpoint. Use the host for the region your organization is hosted in. Official Bird SDKs and the CLI select it automatically from your API key, so you rarely need to set it by hand.
  - `region`: `us1`, `eu1`. Default: `us1`. The region your organization's data is hosted in.
- `https://platform.bird.com`: Region-independent endpoint for authentication and account administration.
- `http://localhost:8080`: Local development.

## Authentication

Use one authentication option:

- `BearerAuth`: HTTP bearer authentication. Pass the API key as a bearer token in the `Authorization` header. Workspace
keys use `bk_{region}_*`; organization master keys use `bm_{region}_*`.
The prefix identifies the region and selects the
API endpoint. Official Bird SDKs and the CLI derive the region from the key.

- `CookieAuth`: Send `bird_session` in cookie. Session cookie set after signing in to the Bird dashboard. The cookie
value is an opaque session token; no session data is stored in the cookie
itself.

## Code samples

**TypeScript**

```ts
const group = await bird.voice.ringGroups.create({ name: "Support" });
console.log(group.id, group.name);
```

Examples: [TypeScript](/docs/api/reference/create-voice-ring-group.ts.md) · [Python](/docs/api/reference/create-voice-ring-group.py.md) · [Go](/docs/api/reference/create-voice-ring-group.go.md) · [PHP](/docs/api/reference/create-voice-ring-group.php.md) · [CLI](/docs/api/reference/create-voice-ring-group.cli.md) · [MCP](/docs/api/reference/create-voice-ring-group.mcp.md) · [cURL](/docs/api/reference/create-voice-ring-group.curl.md)

## Example response `201`

```json
{
  "id": "vrg_01krdgeqcxet5s7t44vh8rt9mg",
  "name": "Support",
  "is_default": false,
  "online_member_count": 0,
  "created_at": "2026-10-01T12:00:00Z",
  "updated_at": "2026-10-01T12:00:00Z"
}
```

## Header parameters

- `Idempotency-Key` (string, optional)

  Client-supplied key. On operations supporting request deduplication, a retained
  response is replayed for duplicate requests with the same key within the
  idempotency window (3 hours by default). This protection requires a workspace,
  organization, or staff-account scope. User-only and unscoped unauthenticated operations,
  streams, and operations with a separate replay contract do not use this
  response replay.

  On a supported operation, if idempotency protection is unavailable before execution, the API returns
  `503 IdempotencyUnavailable` (E01033) without executing this attempt. Retry with
  backoff using the same key and request. An operation that takes effect before
  its response is retained can still execute again on retry.

  Two distinct 409 errors signal misuse:

  - `request_in_progress` (E01004): The same key is currently being
    processed by a concurrent request. Wait briefly and retry. The lock expires within 30 seconds.
  - `idempotency_key_reuse` (E01005): The same key has already completed
    against a different request body or method. Generate a new key.

  Recommended key format is `<event-type>/<entity-id>` (for example `welcome-user/usr_abc123`).
- `X-Workspace-Id` (string, optional): Workspace context for the request. Required for dashboard authentication and master keys. Workspace keys and access tokens already identify their workspace; send that workspace or omit the header. A different one is rejected.
- `X-Organization-Id` (string, optional): Organization context for the request. Required for dashboard authentication. An API key or access token carries its own organization, so send either that organization or no header at all; a different one is rejected.

## Request body

- `name` (string, required): The ring group's name.

## Response body

- `id` (string, required): Unique identifier for this ring group. The default group's ID is `vrg_` followed by the workspace ID's suffix.
- `name` (string, required): The ring group's name.
- `is_default` (boolean, required): Whether this is the workspace's default group, which rings the users who are online in the browser phone.
- `online_member_count` (integer, required): How many of the group's members are connected to the browser phone and accepting calls, read live. A member on a call counts, though a call to the group skips them until it ends. For the default group, the count includes every connected user who accepts calls.
- `created_at` (nullable string, required): When the ring group was created. Null for the default group.
- `updated_at` (nullable string, required): When the ring group's name or members last changed. Null for the default group.

## Related resources

- [Should I use a Bird SDK or call the API directly?](/explained/platform/should-i-use-an-sdk-or-call-the-api-directly) (answer)
- [Build your first integration](/learn/paths/integration) (course)
- [Send your first email](/docs/get-started/send-your-first-email) (docs)

[Get an implementation brief](/learn/workspace?topic=api-basics)