POST
/

A POST request to / sets top-level configuration options for your domain.

The request returns a domain object on success. On failure, it returns an HTTP error.

Body params

properties

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

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.

Default: true

Sets whether rooms for this domain 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.

Default: false

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: false

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: false

Determines whether participants enter a waiting room with a camera, mic, and browser check before joining a call in any room under this domain.

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

Default: true

Sets whether rooms for this domain have Daily Prebuilt’s breakout rooms feature enabled. When set to true, an owner in a Prebuilt call can create breakout rooms to divide participants into smaller, private groups.

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

⚠️ This property is in beta.

Default: false

Sets whether participants in a room see a closed captions button in their Daily Prebuilt call tray. When the closed caption button is clicked, closed captions are displayed locally.

When set to true, a closed captions button appears in the call tray. When set to false, the closed captions button is hidden from the call tray.

Note: Transcription must be enabled for the room or users must have permission to start transcription for this feature to be enabled. View the transcription guide for more details.

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

Default: false

Determines whether the network button, and the network panel it reveals on click, appears across all rooms belonging to this domain.

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

Default: false

Determines whether Daily Prebuilt displays noise cancellation controls. When set to true, a participant can enable microphone noise cancellation 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. To learn more about adding noise cancellation to a custom application, see the updateInputSettings() docs.

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

Whether "Powered by Daily" displays in the in-call UI.

Default: false

(For meetings that open in a separate browser tab.) When a user clicks on the in-call menu bar's "leave meeting" button, the browser loads this URL. A query string that includes a parameter of the form recent-call=<domain>/<room> is appended to the URL. On mobile, you can redirect to a deep link to bring a user back into your app.

Email us at help@daily.co to turn on HIPAA. Learn more about our HIPAA compliance.

Default: false

Whether to automatically start recording when an Intercom support agent joins an Intercom-created call. Please see our Intercom Messenger App page for more information.

⚠️This method is read-only; please contact us if you'd like to enable intercom call auto-recording.

string

The default language for the video call UI, for all calls.

If you set the language at this domain level, you can still override the setting for specific rooms in a room's configuration properties, or for a specific participant in a meeting token.

You can also set the language dynamically using the front-end library setDailyLang() method.

* 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","pt-BR","pl","ru","sv","tr","user"
Default: en

Sets a URL that will receive a webhook when a user joins a room.

Default: NULL
string

Daily uses signaling servers to manage all of the participants in a given call session. In an SFU/server mode call, the server will send and receive all 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. The first participant's 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-south-1" (Mumbai)

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-south-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.

Disable the fall back behavior of rtmp_geo. When rtmp_geo is set, we first try to connect to a media server in desired region. If a media server is not available in the desired region, we fall back to default region based on SFU's region. This property disables this automatic fall back. When this property is set, we will trigger a recording/streaming error event when media worker is unavailable. Also, the client should retry recording/streaming.

Default: false

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 guides for supporting large experiences for additional instruction.

Default: false

Live transcriptions generated can be saved as WebVTT. This flag controls if transcription started with startTranscription() should be saved or not.

Default: false

Configures an S3 bucket in which to store transcriptions. See the S3 bucket guide for more information.

The name of the Amazon S3 bucket to use for transcription 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 transcription in the specified bucket.

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

Cloud recordings are stored in either Daily's S3 bucket or the customer's own S3 bucket. By default recordings are stored as {domain_name}/{room_name}/{epoch_time}. Sometimes, the use case may call for custom recording file names to be used (for example, if you'd like to enforce the presence of the .mp4 extension in the file name).

recordings_template is made up of a replacement string with prefixes, suffixes, or both. The currently supported replacements are:

  • epoch_time: The epoch time in seconds (mandatory)
  • domain_name: Your Daily domain (optional)
  • room_name: The name of the room which is getting recorded (optional)
  • mtg_session_id: The ID of the meeting session which is getting recorded (optional)
  • instance_id: The instance ID of the recording (optional)
  • recording_id: The recording ID of the recording (optional)

The restrictions for defining a recording template are as follows:

  • The epoch_time tag is mandatory to ensure the recording file name is unique under all conditions
  • The maximum size of the template is 1024 characters
  • Each replacement parameter should be placed within a curly bracket (e.g., {domain_name})
  • Only alphanumeric characters (0-9, A-Z, a-z) and ., /, -, _ are valid within the template
  • .mp4 is the only valid extension

Examples

  • Example domain: "myDomain"
  • Example room: "myRoom"

Example 1:

  • Template: myprefix-{domain_name}-{epoch_time}.mp4
  • Resulting file name: myprefix-myDomain-1675842936274.mp4

Example 2:

  • Template: {room_name}/{instance_id}/{epoch_time}
  • Resulting room name: myRoom/d529cd2f-fbcc-4fb7-b2c0-c4995b1162b6/1675842936274
Default: {domain_name}/{room_name}/{epoch_time}.

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 interactive live streaming for additional instruction.

Dictates the participant count after which room topology automatically switches from Peer-to-Peer (P2P) to Selective Forwarding Unit (SFU) mode, or vice versa.

For example, if sfu_switchover is set to 2 and the current network topology is P2P, the topology will switch to SFU mode when the third participant joins the call. If the current topology is SFU, it will switch to P2P mode when the participant count decreases from 2 to 1.

We recommend specifying an integer value for this property except for cases where you would like the room to switch to SFU mode as soon as the first participant joins. In this case, set sfu_switchover to 0.5.

See our guide about video call architecture for additional information.

Default: 0.5

Configures an S3 bucket in which to store recordings. See the S3 bucket guide for more information.

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.

Controls whether the recording will be accessible using Daily's API.

Specifies which Content-Disposition response header the recording link retrieved from the access-link REST API endpoint will have. If allow_streaming_from_bucket is false, the header will be Content-Dispostion: attachment. If allow_streaming_from_bucket is true, the header will be Content-Disposition: inline. To play the recording link directly in the browser or embed it in a video player, set this property to true.

Default: false

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.

Participant admins (those with the 'participants' value in their canAdmin permission) 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")
boolean | array

Which admin tasks a participant is permitted to do.

Can be:

  • An array containing any of 'participants', 'streaming', or 'transcription'
  • true (meaning "all")
  • false (meaning "none")
Default: { canSend: true, hasPresence: true, canAdmin: false }

Defines a custom S3 bucket where the batch processor will write its output

Enables whether the batch processor will use ScienceIO metadata concepts when generating SOAP notes.

Default: true

Example requests

Set a domain property

Unset a domain property

To unset any domain configuration property — in other words, to reset any property to its default value — set the property to null. For example: