Edit a Player

post

https://partner.api.dailymotion.com/rest/player/{PLAYER_ID}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

PLAYER_ID

string

required

The unique identifier of your Dailymotion profile.

Query Params

fields

string

List of fields to return.

To add several fields, separate each value with a comma (i.e. label,id)

Sample of possible values: label autostart id owner embed_html_url embed_script_url lib_script_url

See the exhaustive list of possible values and their description.

Form Data

label

string

The name of your Player.

aspect_ratio

string

Specify the aspect ratio of the Player.
Possible values: 16:9 4:3 1:1 3:4 9:16 inherit

autonext_after

integer

After how many seconds the next video will be played (min: 0, max: 60).
Note: Needs to be combined with "enable_autonext": true.

autostart

string

Control how the Player handles autoplay.
Possible values: on off firstTimeViewable

autoskip_after

integer

After how many seconds the video is skipped (min: 10).
Note: Needs to be combined with "enable_autoskip": true.
Sample value: 20

color

string

Change the default highlight color used in the controls.
Sample value: 00aaff

contextual_content_freshness

integer

Define the freshness of the content (in days) that can be selected by the contextual embed feature.
Note: Needs to be combined with "enable_contextual_content": true
Sample value: 1800

contextual_content_source

string

Define if your contextual content should be taken from your Organization, your channel, or Dailymotion’s global catalog.
Note: Needs to be combined with "enable_contextual_content": true
Possible values: channel organization dailymotion

enable_ads

boolean

Whether to enable ads and associated tracking.
Default: true

enable_ads_controls

boolean

Whether to display the Player controls during an ad.
Default: true

enable_automatic_recommendations

boolean

Whether to enable automatic recommendations.
Default: true

enable_autonext

boolean

Whether to automatically play the next video item.
Default: true

enable_autoskip

boolean

Whether to activate the "Autoskip" feature.
Default: false

enable_channel_link

boolean

Whether to activate the link on the channel owner.
Default: true

enable_click_to_unmute

boolean

Whether to enable the click to unmute feature.
Default: true

enable_contextual_content

boolean

Whether to load relevant content based on contextual information from the embedder page.
Default: false

enable_contextual_content_fallback

boolean

When enable_contextual_content is activated: Whether to allow the contextual embed feature to play less relevant videos from your channel or other sources, to avoid displaying an empty player when content with high relevancy is not available.
Default: true

enable_contextual_content_freshness

boolean

Whenenable_contextual_content is activated: Whether to activate the "Contextual content freshness" feature.
**If set to true: ** Combine with contextual_content_freshness to define the freshness of the content (in days).
Default: false

enable_custom_recommendations

boolean

Whether to enable custom recommendations.
Default: false

enable_dm_logo

boolean

Whether to display the Dailymotion logo.
Default: true

enable_eco_mode

boolean

Whether to enable eco mode to apply a quality limit.
Default: true

enable_google_policy_ui

boolean

When pip is activated: Whether to activate the UI to be Google policy compliant (e.g.: PIP close button outside Player UI).
Default: false

enable_info

boolean

Whether to display the video title and owner information.
Default: true

enable_keyboard_shortcuts

boolean

Whether to enable the keyboard shortcuts.
Default: true

enable_legacy_pip

string

When enabled, player displays the legacy PiP version

enable_live_offair_screen

boolean

Whether to display streaming status before and after live streaming.
Default: false

enable_paid_partnership_label

boolean

Whether to enable the paid partnership label (if the playing video is flagged as such).
Default: false

enable_playback_controls

boolean

Whether to display the Player controls during a video.
Default: true

enable_receive_url_location

boolean

Allow Player to receive full page URL where Player is embedded.
Default: true

enable_sharing

boolean

Whether to enable the sharing button.
Default: true

enable_sharing_url_location

boolean

Whether to share the location where the video is embedded (video URL by default).
Default: true

enable_start_pip_expanded

boolean

When pip is true: Whether to start PiP in expanded mode on mobile.
Default: false

enable_startscreen_dm_link

boolean

Whether to show the "Watch on Dailymotion" link on the start screen.
Default: true

enable_subtitles

boolean

Whether to activate the subtitles in the Player.
Default: true

enable_tap_to_unmute

boolean

Whether to enable the tap to unmute feature.
Default: true

enable_titles_in_video_cards

boolean

Whether to show the videos titles in the carousel on the end screen.
Default: true

enable_video_title_link

boolean

Whether to activate the link on the video title.
Default: true

enable_wait_for_custom_config

boolean

Whether to configure the Player to wait for the custom config object before starting playback.
Default: false

enable_watch_now_card

boolean

Whether to display one video card after playback.
Default: true

pip

string

Whether to activate Picture-in-Picture mode.
Possible values:
- instant: PiP launches as soon as the Player is loaded.
- on: PiP enabled.
- off: PiP disabled.

recommendations_optimisation

string

Optimise recommendations based on the selected model.
Possible values:
- monetization: Recommends videos with high revenue potential.
- engagement: Recommends videos relevant to the initial one, with a focus on content generating more user interactions.
- views: Recommends videos relevant to the initial one, with a focus on content generating more views.

wait_for_custom_config_delay

integer

Whenenable_wait_for_custom_config is true: How long to wait before the ad request is made (min: 1s – max: 10s).
Min: 1
Max: 10

watermark_image_type

string

Image type of the watermark.
Possible values: none from_channel custom

watermark_link_type

string

Type of watermark link.
Possible values: none from_channel custom

watermark_link_url

string

URL of the watermark link.
Sample value: https://www.dailymotion.com

Response

200