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

# Add a member to a ring group

`POST /v1/voice/ring-groups/{ring_group_id}/members`

Adds a workspace user to the ring group. The group rings the user only
while they are online in the browser phone.

A user without access to the workspace returns `422`, as does adding a
member to a group that already has 200. Adding a user who is already a
member, or adding to the default group, returns `409 Conflict`.

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 member = await bird.voice.ringGroups.members.create("RING_GROUP_ID", { user_id: "USER_ID" });
console.log(member.user_id);
```

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

## Example response `201`

```json
{
  "user_id": "usr_01krdgeqcxet5s7t44vh8rt9mg",
  "created_at": "2026-10-01T12:00:00Z"
}
```

## Path parameters

- `ring_group_id` (string, required): ID of the ring group whose members to list or add to.

## 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

- `user_id` (string, required): The workspace user to add. `bird members list` and the `members_list` MCP tool list workspace members in pages, each with its `user.id`; follow `next_cursor` until the user appears. Both need the `members` scope at read level.

## Response body

- `user_id` (string, required): The member's user ID.
- `created_at` (nullable string, required): When the user joined the ring group. Null for the default group, whose members are the users online now.

## 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)