<Intro>

<EndpointHeader />

<Description>

Updates a Realtime app's name and configuration flags. Region is immutable; TLS is always enforced. Omitted fields are left unchanged.

</Description>

</Intro>

<Payload kind="request">

<Field name="name" type="string" />

<Field name="client_events" type="boolean">

<Description>

Allow clients to trigger events directly (client events).

</Description>

</Field>

<Field name="connection_counting" type="boolean">

<Description>

Emit connection-count events on channels.

</Description>

</Field>

<Field name="authorized_connections" type="boolean">

<Description>

Require every connection to be authorized.

</Description>

</Field>

</Payload>

<Payload kind="response">

<Field name="created_at" type="string" required />

<Field name="updated_at" type="string" required />

<Field name="client_events" type="boolean" required>

<Description>

Allow clients to trigger events directly (client events).

</Description>

</Field>

<Field name="connection_counting" type="boolean" required>

<Description>

Emit connection-count events on channels.

</Description>

</Field>

<Field name="authorized_connections" type="boolean" required>

<Description>

Require every connection to be authorized.

</Description>

</Field>

<Field name="id" type="string" required />

<Field name="app_id" type="integer" required>

<Description>

The numeric Realtime app id. Use it together with a key and secret to initialize a Realtime client/server SDK. Immutable.

</Description>

</Field>

<Field name="name" type="string" required />

<Field name="region" type="object" required>

<Description>

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.

</Description>

</Field>

<Field name="status" type="string" required>

<Description>

Lifecycle state of the app. `active` apps serve connections; `suspended` apps are provisioned but reject connections.

</Description>

<Description>

Possible values: `active`, `suspended`

</Description>

</Field>

</Payload>