---
# @generated by sylphx-gen. Do not edit.
title: "Join a realtime channel"
description: "`events.realtime_channels.join` (POST /v1/{name}:join): Joins a persistent Chat conversation."
type: reference
product: queues
summary: "Joins a persistent Chat conversation."
updated: 2026-09-28
nav: false
---

Joins a persistent Chat conversation.

- **Path** `POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/realtime_channels/realtime-channel:join`
- **Scope** `events:write`
- **Effect** `write` — a successful call changes state.
- **Collection** [realtime_channels](/docs/api/realtime_channels)

## Request

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | Existing channel name. Required. |
| `client_id` | `string` | Authenticated member identity. Required. |
| `role` | `string` | member or moderator; default member. |

## Response

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | `…/realtime_channels/{realtime_channel}/realtime_members/{realtime_member}`. |
| `uid` | `string` | `rtb_<cell><ulid>`; never reused. Output only. |
| `meta` | `ResourceMeta` | Resource metadata. |
| `client_id` | `string` | The client id its token names. Output only. |
| `data` | `value` | The member's presence data (set at enter, changed by an update). Output only. |
| `enter_time` | `timestamp` | When the member entered. Output only. |
| `connection_count` | `int32` | Open connections of this client in the channel. Output only. |
| `joined` | `bool` | Persistent Chat membership, independent of online connections. Output only. |
| `last_read_cursor` | `string` | Last acknowledged stream cursor; updates never move backwards. Output only. |
| `unread_count` | `int64` | Unread visible Chat messages from other members, excluding blocked senders. Output only. |
| `muted` | `bool` | Suppress this conversation's notification intents. Output only. |
| `role` | `string` | Member or moderator, assigned by the tenant backend. Output only. |
| `pinned` | `bool` | This channel is an official, verified support conversation. Output only. |

### ResourceMeta

| Field | Type | What it is |
| --- | --- | --- |
| `generation` | `int64` | Increases by one on every change to `spec`. Output only. |
| `etag` | `string` | Strong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as `If-Match` or `etag` to make Update and Delete conditional; a mismatch fails with ABORTED / 409 `ETAG_MISMATCH`. Output only. |
| `create_time` | `timestamp` | When the Resource was created. Output only. |
| `update_time` | `timestamp` | When the Resource last changed. Output only. |
| `delete_time` | `timestamp` | Set while the Resource is being deleted. Output only. |
| `labels` | `map<string, string>` | Caller-writable, indexed labels (AIP-122 label rules). |
| `annotations` | `map<string, string>` | Caller-writable, unindexed annotations. |
| `display_name` | `string` | Caller-writable human-readable name. |
| `creator` | `string` | The principal that created the Resource. Output only. |

## Errors

- [`UNAUTHENTICATED`](/docs/api/errors/UNAUTHENTICATED) — No valid key or token was presented.
- [`PERMISSION_DENIED`](/docs/api/errors/PERMISSION_DENIED) — The key lacks the method's permission.
- [`RESOURCE_NOT_FOUND`](/docs/api/errors/RESOURCE_NOT_FOUND) — The named Resource does not exist or is not visible.
- [`INVALID_FIELD`](/docs/api/errors/INVALID_FIELD) — A field failed validation.
- [`INVALID_STATE`](/docs/api/errors/INVALID_STATE) — The Resource is in a state that forbids the call.

Every error arrives in the body [Errors](/docs/platform/errors) describes.

## Examples

**cURL**

```curl
curl -X POST "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/realtime_channels/realtime-channel:join" \
  -H "Authorization: Bearer $SYLPHX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"client_id":"…"}'
```

**TypeScript**

```ts
const response = await sylphx.events.realtimeChannels.join({ clientId: '…', name: 'orgs/acme/projects/shop/envs/production/realtime_channels/realtime-channel' })
```

**Rust**

```rust
let mut req = sylphx::events::JoinRealtimeChannelRequest::default();
req.client_id = "…".to_string();
req.name = "orgs/acme/projects/shop/envs/production/realtime_channels/realtime-channel".to_string();
let response = sx.events().realtime_channels().join(req).await?;
```

**CLI**

```bash
sylphx events realtime-channels join orgs/acme/projects/shop/envs/production/realtime_channels/realtime-channel
```

**MCP**

```json
{ "method_id": "events.realtime_channels.join", "args": {"client_id":"…","name":"orgs/acme/projects/shop/envs/production/realtime_channels/realtime-channel"} }
```