---
# @generated by sylphx-gen. Do not edit.
title: "React a realtime message"
description: "`events.realtime_messages.react` (POST /v1/{name}:react): Adds or removes a member reaction on a visible Chat message."
type: reference
product: queues
summary: "Adds or removes a member reaction on a visible Chat message."
updated: 2026-09-28
nav: false
---

Adds or removes a member reaction on a visible Chat message.

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

## Request

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | Existing message resource name. Required. |
| `client_id` | `string` | Authenticated reacting member. |
| `emoji` | `string` | Emoji, at most 32 UTF-8 bytes. |
| `remove` | `bool` | Remove instead of add. |

## Response

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | `…/realtime_channels/{realtime_channel}/realtime_messages/{realtime_message}`. |
| `uid` | `string` | `rtm_<cell><ulid>`; never reused. Output only. |
| `meta` | `ResourceMeta` | Resource metadata. |
| `cursor` | `string` | The message's place in the channel; send it back as `after_cursor` (or `Last-Event-ID`) to resume after it. Output only. |
| `sequence` | `int64` | The position in the channel, from 1, gap-free. Output only. |
| `message_type` | `string` | The message name (`chat.message`, `presence.enter`, …). Required. |
| `data` | `value` | The payload. |
| `client_id` | `string` | The publisher's client id, when it named one. |
| `publish_time` | `timestamp` | When the channel appended it. Output only. |
| `content` | `ChatMessageContent` | Structured Chat content, from the same stored event as data. Output only. |
| `sender` | `ChatSender` | Verified sender metadata; callers cannot set the official badge on a message. Output only. |
| `reactions` | `ChatReaction[]` | Member reactions, from the same conversation authority. 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. |

### ChatMessageContent

| Field | Type | What it is |
| --- | --- | --- |
| `text` | `string` | UTF-8 text, at most 4000 characters. |
| `image` | `ChatImage` | An image with a prior moderation approval. |
| `location` | `ChatLocation` | One explicit static location pin. |
| `poll` | `ChatPoll` | A member poll. |
| `room_invite` | `string` | Existing Realtime room resource name for a Join Game card. |
| `reply_to_cursor` | `string` | Optional cursor of the quoted message in this channel. |
| `mentioned_client_ids` | `string[]` | Member ids mentioned by this message. |
| `sticker` | `ChatSticker` | A paid catalog asset; the server verifies entitlement and stamps its bytes. |

### ChatSender

| Field | Type | What it is |
| --- | --- | --- |
| `client_id` | `string` | The authenticated user's stable platform identity as bound by its backend. |
| `display_name` | `string` | Display name, from the sender's profile. |
| `official` | `bool` | Verified official status, assigned through a trusted backend operation. |
| `cosmetics` | `ChatCosmetics` | Persisted trusted appearance when this message was accepted. Output only. |

### ChatReaction

| Field | Type | What it is |
| --- | --- | --- |
| `emoji` | `string` | Reaction emoji. |
| `count` | `int32` | Number of members with this reaction. |
| `client_ids` | `string[]` | Stable reacting member identities. |

### ChatImage

| Field | Type | What it is |
| --- | --- | --- |
| `content_uri` | `string` | Existing storage or Artifacts URI; no image bytes are carried here. Required. |
| `sha256` | `string` | Lowercase SHA-256, 64 hexadecimal characters. Required. |

### ChatLocation

| Field | Type | What it is |
| --- | --- | --- |
| `latitude` | `double` | Degrees north, inclusive -90 to 90. |
| `longitude` | `double` | Degrees east, inclusive -180 to 180. |
| `label` | `string` | Optional venue label; never continuous or background location. |

### ChatPoll

| Field | Type | What it is |
| --- | --- | --- |
| `question` | `string` | Question shown to members. |
| `options` | `string[]` | Two to ten distinct choices. |

### ChatSticker

| Field | Type | What it is |
| --- | --- | --- |
| `pack_id` | `string` | Catalog pack identifier; the complete Money feature key is at most 64 bytes. Required. |
| `sticker_id` | `string` | Identifier inside the pack. Required. |
| `content_uri` | `string` | Optional on send; if supplied must match the catalog. Output is authoritative. |
| `sha256` | `string` | Optional on send; exact lowercase SHA-256 from the catalog. |
| `mime_type` | `string` | Optional on send; exact catalog image MIME type. |

### ChatCosmetics

| Field | Type | What it is |
| --- | --- | --- |
| `avatar_frame_id` | `string` | Owned avatar-frame identifier, assigned by the trusted backend. |
| `name_color_id` | `string` | Owned name-color identifier, assigned by the trusted backend. |
| `title_badge_id` | `string` | Owned title-badge identifier, assigned by the trusted backend. |

## Errors

- [`PERMISSION_DENIED`](/docs/api/errors/PERMISSION_DENIED) — The key lacks the method's permission.
- [`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.
- [`RESOURCE_NOT_FOUND`](/docs/api/errors/RESOURCE_NOT_FOUND) — The named Resource does not exist or is not visible.

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/realtime_messages/realtime-message:react" \
  -H "Authorization: Bearer $SYLPHX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

**TypeScript**

```ts
const response = await sylphx.events.realtimeMessages.react({ name: 'orgs/acme/projects/shop/envs/production/realtime_channels/realtime-channel/realtime_messages/realtime-message' })
```

**Rust**

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

**CLI**

```bash
sylphx events realtime-messages react orgs/acme/projects/shop/envs/production/realtime_channels/realtime-channel/realtime_messages/realtime-message
```

**MCP**

```json
{ "method_id": "events.realtime_messages.react", "args": {"name":"orgs/acme/projects/shop/envs/production/realtime_channels/realtime-channel/realtime_messages/realtime-message"} }
```