POST
/rooms/:room

A POST request to /rooms/:name modifies a room object's privacy or configuration properties.

Returns a room object if the operation is successful.

In the case of an error, returns an HTTP error with information about the error in the response body.

Path params

string

Defaults to a randomly generated string A room name can include only the uppercase and lowercase ascii letters, numbers, dash and underscore. In other words, this regexp detects an invalid room name: /[^A-Za-z0-9_-]/.

Together, the domain name and the room name cannot exceed 41 characters. You'll get an error if you try to create a room with a name that's too long.

Body params

privacy

string
Determines who can access the room.
Options: "public","private"
Default: "public"

properties

integer

"Not before". This is a unix timestamp (seconds since the epoch.) Users cannot join a meeting in this room before this time.

Default: <not set>
integer

"Expires". This is a unix timestamp (seconds since the epoch.) Users cannot join a meeting in this room after this time.

More resources:

Default: <not set>

How many people are allowed in a room at the same time.

⚠️ Contact us if you need to set the limit above 200.

Default: 200

Determines if Daily Prebuilt displays the People UI. When set to true, a People button in the call tray reveals a People tab in the call sidebar. The tab lists all participants, and next to each name indicates audio status and an option to pin the participant. When enable_people_ui is set to false, the button and tab are hidden.

⚠️ Has no effect on custom calls built on the Daily call object.

⚠️ If owner_only_broadcast is set to true and enable_chat is set to false, then the People UI is already hidden for participants.

Default: NULL

Sets whether the room can use Daily Prebuilt's Picture in Picture controls. When set to true, an additional button will be available in Daily Prebuilt's UI to toggle the Picture in Picture feature.

⚠️ This flag only applies to Daily Prebuilt. It has no effect when building custom video applications with the Daily call object.

⚠️ This property is in beta as of daily-js 0.24.0.

Default: NULL

Determines if Daily Prebuilt displays the Emoji Reactions UI. When set to true, a Reactions button appears in the call tray. This button allows users to select and send a reaction into the call. When set to false, the Reactions button is hidden and the feature is disabled.

Usage: This feature is a good fit for meetings when a host or presenter would benefit from receiving nonverbal cues from the audience. It's also great to keep meetings fun.

⚠️ This flag only applies to Daily Prebuilt. It has no effect when building custom video applications with the Daily call object.

Default: NULL

Sets whether the participants in the room can use Daily Prebuilt's hand raising controls. When set to true, an additional button will be available in Daily Prebuilt's UI to toggle a hand raise.

⚠️ This flag only applies to Daily Prebuilt. It has no effect when building custom video applications with the Daily call object.

Default: NULL

Determines whether participants enter a waiting room with a camera, mic, and browser check before joining a call.

⚠️ You must be using Daily Prebuilt to use enable_prejoin_ui.

Default: NULL

Determines whether the network button, and the network panel it reveals on click, appears in this room.

⚠️ You must be using Daily Prebuilt to use enable_network_ui.

Default: NULL

Turns on a lobby experience for private rooms. A participant without a corresponding meeting token can request to be admitted to the meeting with a "knock", and wait for the meeting owner to admit them.

Requires the signaling_impl room or domain property set to "ws".

Default: NULL
Default: true

Determines whether Daily Prebuilt displays background blur controls. When set to true, a participant can enable blur during a Daily Prebuilt call.

⚠️ This flag only applies to Daily Prebuilt. It has no effect when building custom video applications with the Daily call object.

Default: true
Default: false

When a participant first joins a meeting in a room, keep their camera off.

Default: false

When a participant first joins a meeting in a room, keep their microphone muted.

Default: false

In Daily Prebuilt, only the meeting owners will be able to turn on camera, unmute mic, and share screen

See setting up calls.

Default: false

Jump to recording docs.

Note: If you’re planning to use output-byte-stream, you must monitor recording-data events.

Options: "cloud","local","raw-tracks","output-byte-stream","<not set>"
Default: <not set>

If there's a meeting going on at room exp time, end the meeting by kicking everyone out. This behavior can be overridden by setting eject properties of a meeting token.

Default: false

Eject a meeting participant this many seconds after the participant joins the meeting. You can use this is a default length limit to prevent long meetings. This can be overridden by setting eject properties of a meeting token.

Property that gives end users a richer chat experience. This includes:

  • Emoji reactions to chat messages
  • Emoji picker in the chat input form
  • Ability to send a Giphy chat message

⚠️ This flag only applies to Daily Prebuilt. It has no effect when building custom video applications with the Daily call object.

Default: false

When enabled, non-owner users join a meeting with a hidden presence, meaning they won't appear as a named participant in the meeting and have no participant events associated to them. Additionally, these participants can only receive media tracks from owner participants.

Hidden participants can be tracked using the participantCounts() method. Hidden participants do not have entries in the participants() method return value.

When used with Daily Prebuilt, hidden participants are included in the participant count available in the UI; however, are not included in the People panel and can only read chat messages.

This property should be used to support hosting large meetings. See our guide for supporting large calls for additional instruction.

Default: false

Configures a room to use multiple SFUs for a call's media. This feature enables calls to scale to large sizes and to reduce latency between participants. It is recommended specifically for interactive live streaming.

See our guide for supporting large calls for additional instruction.

Default: NULL

Enables Daily Prebuilt to support group calls of up to 1,000 participants and owner only broadcast calls of up to 100K participants.

When set to true, Daily Prebuilt will:

  • Automatically mute the local user on joining
  • Update grid view to show a maximum of 12 users in the grid at a time
  • Allow only 8 users to be unmuted at the same time. When more than 8 users are unmuted, the oldest active speaker will be automatically muted.

See our guide for supporting large calls for additional instruction.

⚠️ This flag only applies to Daily Prebuilt. It has no effect when building custom video applications with the Daily call object.

Default: NULL
string

The default language of the Daily prebuilt video call UI, for this room.

Setting the language at the room level will override any domain-level language settings you have.

Read more about changing prebuilt UI language settings.

* Norwegian "no" and Russian "ru" are only available in the new Daily Prebuilt.

Options: "de","en","es","fi","fr","it","jp","ka","nl","no","pt","pl","ru","sv","tr","user"
Default: "en"

Sets a URL that will receive a webhook when a user joins a room. Default is NULL. Character limit for webhook URL is 255.

More resources:

Default: NULL

Sets the signaling type.

Options: "ws"
Default: "ws"
string

Daily calls use signaling servers to manage all of the participants in a given call session. In an SFU/server mode call, that same server will also send and receive all the audio and video from each participant. In a peer-to-peer call, each participant sends media directly to and from each other peer, but a signaling server still manages call state.

Daily runs servers in several different AWS regions to minimize latency for users around the world. The job of 'picking' a call server is handled when the first participant joins a room. Their browser connects to a call server using Amazon's Route 53 DNS resolution, which chooses a server in the region closest to them.

This isn't always optimal. For example, if one person joins in London, and then ten more people join from Cape Town, the call will still be hosted out of eu-west-2 . The majority of the participants will have higher latency to the server than if one of them had joined first and the call was being hosted in af-south-1. In cases like this, you may want to configure your domain (or a specific room) to always choose a call server in a specific AWS region.

Available regions:

  • "af-south-1" (Cape Town)
  • "ap-northeast-2" (Seoul)
  • "ap-southeast-1" (Singapore)
  • "ap-southeast-2" (Sydney)
  • "ap-south-1" (Mumbai)
  • "eu-central-1" (Frankfurt)
  • "eu-west-2" (London)
  • "sa-east-1" (São Paulo)
  • "us-east-1" (N. Virginia)
  • "us-west-2" (Oregon)
Default: NULL
string

Used to select the region where an RTMP stream should originate. In cases where RTMP streaming services aren't available in the desired region, we'll attempt to fall back to the default region based on the SFU being used for the meeting.

Available regions:

  • "us-west-2" (Oregon)
  • "eu-central-1" (Frankfurt)
  • "ap-southeast-1" (Singapore)

The default regions are grouped based on the SFU region like so:

  • RTMP region "us-west-2" includes SFU regions: "us-west-2", "us-east-1", "sa-east-1"
  • RTMP region "eu-central-1" includes SFU regions: "eu-central-1", "eu-west-2", "af-south-1"
  • RTMP region "ap-southeast-1" includes SFU regions: "ap-southeast-1", "ap-southeast-2", "ap-northeast-2", "ap-south-1"
Default: The closest available region to the SFU region used by the meeting.

Configures an S3 bucket in which to store recordings.

Properties:

The name of the Amazon S3 bucket to use for recording storage.

The region which the specified S3 bucket is located in.

The Amazon Resource Name (ARN) of the role Daily should assume when storing the recording in the specified bucket.

Whether the recording should be accessible using Daily's API.

Reduces the volume of log messages. This feature should be enabled when there are more than 200 participants in a meeting to help improve performance.

See our guide for supporting large calls for additional instruction.

Default: false

An array of stream endpoint configuration objects, which allows configurations to be pre-defined without having to pass them into startLiveStreaming() at runtime. For example, an RTMP endpoint can be set up for YouTube as a streaming_endpoints configuration along with another configuration for HLS storage.

HLS output can only be stored on a customer's S3, not in Daily's storage infrastructure. The stream configuration defines which S3 bucket to store the HLS output. (See the S3 bucket guide for more information.)

Example:

To reset the streaming_endpoints property, pass null instead of an array.

When calling startLiveStreaming(), the pre-defined streaming_endpoints name can be used:

Properties:

string

Used by the startLiveStreaming() API to reference which stream configuration to start.

string

Whether the streaming endpoint is rtmp or hls.

The s3Key path prefix for where to store the recordings. Therefore, the final final master.m3u8 path template is <bucket_name>/<path>/<mtgSessionId>/master.m3u8, i.e. hls_config['storage']['bucket_name']/hls_config['storage']['path']/<mtgSessionId>/master.m3u8.

If true, the live stream will be saved as a recording after streaming has ended. If false, the stream is available only until the streaming is live.

Default: NULL

Specifies the initial default permissions for a non-meeting-owner participant joining a call.

Each permission (i.e. each of the properties listed below) can be configured in the meeting token, the room, and/or the domain, in decreasing order of precedence.

Meeting owners can also change participants' permissions on the fly during a call using updateParticipant() or updateParticipants().

Whether the participant appears as "present" in the call, i.e. whether they appear in participants().

boolean | array

Which types of media a participant should be permitted to send.

Can be:

  • An Array containing any of 'video', 'audio', 'screenVideo', and 'screenAudio'
  • true (meaning "all")
  • false (meaning "none")
Default: <not set>

Example requests

Change a room's privacy

Change a room's max_participants property

Change a room's max_participants property back to default