Update a Realtime app
PATCH
/v1/realtime/apps/{realtime_app_id}
bird realtime apps update <realtime-app-id> \
--connection-counting=true \
--name chat-productioncurl -X PATCH "https://us1.platform.bird.com/v1/realtime/apps/{realtime_app_id}" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{
"name": "chat-production",
"connection_counting": true
}'प्रतिक्रिया200
{
"created_at": "2026-05-20T09:14:52Z",
"updated_at": "2026-05-25T16:42:01Z",
"id": "rap_01krdgeqcxet5s7t44vh8rt9mg",
"app_id": 432557,
"name": "chat-production",
"region": "us1",
"status": "active"
}
Updates a Realtime app's name and configuration flags. Region is immutable; TLS is always enforced. Omitted fields are left unchanged.
पैरामीटर
realtime_app_id
string
ID of the Realtime app (rap_ prefix), as returned when the app was created.
Request Payload
name
string
A label for the app, shown wherever it is listed.
client_events
boolean
Allow clients to trigger events directly (client events).
connection_counting
boolean
Count the connections subscribed to each channel and expose the count on channel queries.
connection_count_events
boolean
Broadcast a connection-count event to a channel's subscribers whenever its connection count changes. Requires connection_counting.
watchlist_events
boolean
Tell a signed-in member when the members on their watchlist come online or go offline. The watchlist is part of the identity your backend signs at signin.
authorized_connections
boolean
Require every connection to be authorized.
Response Payload
created_at
string
आवश्यक
updated_at
string
आवश्यक
client_events
boolean
आवश्यक
Allow clients to trigger events directly (client events).
connection_counting
boolean
आवश्यक
Count the connections subscribed to each channel and expose the count on channel queries.
connection_count_events
boolean
आवश्यक
Broadcast a connection-count event to a channel's subscribers whenever its connection count changes. Requires connection_counting.
watchlist_events
boolean
आवश्यक
Tell a signed-in member when the members on their watchlist come online or go offline. The watchlist is part of the identity your backend signs at signin.
authorized_connections
boolean
आवश्यक
Require every connection to be authorized.
id
string
आवश्यक
app_id
integer
आवश्यक
The numeric Realtime app id. Use it together with a key and secret to initialize a Realtime client/server SDK. Immutable.
name
string
आवश्यक
A label for the app, shown wherever it is listed.
region
string
आवश्यक
The region this app runs in. Unlike other products, a Realtime app can be placed in a region other than the workspace's home region. Immutable after creation.
status
string
आवश्यक
Lifecycle state of the app. active apps serve connections; suspended apps are provisioned but reject connections.
Possible values: active, suspended
संबंधित संसाधन
इस विषय के लिए डॉक्यूमेंटेशन, गाइड और उदाहरणों के साथ आगे बढ़ें। संसाधन अंग्रेज़ी में हैं।
क्षमता जानेंRealtimeलर्निंग पाथ फ़ॉलो करेंBuild your first integrationइम्प्लीमेंटेशन गाइडSend your first realtime event
अभ्यास करें और इम्प्लीमेंटेशन ब्रीफ़ पाएँ