Update a Realtime app
PATCH
/v1/realtime/apps/{realtime_app_id}
curl -X PATCH "https://us1.platform.bird.com/v1/realtime/apps/{realtime_app_id}" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{}'Updates a Realtime app's name and configuration flags. Region is immutable; TLS is always enforced. Omitted fields are left unchanged.
Verzoekpayload
name
string
client_events
boolean
Allow clients to trigger events directly (client events).
connection_counting
boolean
Emit connection-count events on channels.
authorized_connections
boolean
Require every connection to be authorized.
Response Payload
created_at
string
verplicht
updated_at
string
verplicht
client_events
boolean
verplicht
Allow clients to trigger events directly (client events).
connection_counting
boolean
verplicht
Emit connection-count events on channels.
authorized_connections
boolean
verplicht
Require every connection to be authorized.
id
string
verplicht
app_id
integer
verplicht
The numeric Realtime app id. Use it together with a key and secret to initialize a Realtime client/server SDK. Immutable.
name
string
verplicht
region
object
verplicht
The region this app runs in. Unlike other Bird products, a Realtime app can be placed in a region other than the workspace's home region. Immutable after creation.
status
string
verplicht
Lifecycle state of the app. active apps serve connections; suspended apps are provisioned but reject connections.
Possible values: active, suspended