Update player settings
Updates the player settings for a project
Authorizations
Path Parameters
The numeric ID of your project
Body
Whether the player distribution is on or off
The player version to use. Possible values are 0 for legacy and 1 for the current
0, 1 The style of user interface to show for the player. Possible values are default, small, standard, large, or video
default, small, standard, large, video The title to show in the large player when there isn't a playlist
The text prompt to show on the player
An image to show in the player instead of the content's image
Whether to show clickable ad images in the player when the ad isn't playing
The color theme to use for the player. The color theme to use for the player. Possible values are auto, dark, or light
auto, dark, light The dark theme colors
The light theme colors
The video theme colors
Whether to always show the content's title (e.g. instead of the call_to_action)
Whether to show or hide the image in the player
The style of user interface to show for the widget at the bottom of the screen. Possible values are none, small, standard, large, video The widget appears once you scroll past the player in the page.
none, small, standard, large, video The side of the screen on which to show the widget. Possible values are auto, left, center, right The 'auto' position places the standard player in the center, otherwise to the right.
auto, left, center, right Whether to allow playback by clicking on a segment (i.e. a paragraph) on the page
Whether segments should be highlighted in time with content playback
The style of skip buttons to show in the player. Possible values are segments or seconds You can specify the number of seconds to skip, e.g. seconds-15 or seconds-15-30
The URL of an intro audio file to play before all content in the player
The URL of an outro audio file to play after all content in the player.
Whether or not the intro and outro should be played. The default is false
Whether to show a download button next to each playlist item in the player
Custom analytics server URL
Google Analytics tag enabled
Google Analytics tag
Whether to show the BeyondWords logo in the player
The continuous playback mode. Possible values are none or recent
none, recent The outro playback mode. Possible values are after-all or after-each
after-all, after-each The corner radius of the player, in pixels. The default is 8. Only affects players with the default player_style
The hexadecimal accent color to use in the player. Only affects players with the default player_style
The hexadecimal text color to use on accented elements in the player. Only affects players with the default player_style
The disclosure text to show in the player. Only affects players with the default player_style
The URL the disclosure text links to. Only affects players with the default player_style
The hexadecimal color to use for the agent user interface in the player
The URL of an avatar image to show for the agent in the player
The placeholder text to show in the agent input field in the player
Suggested prompts to show in the agent user interface in the player. The default is an empty array
The informational text to show in the agent user interface in the player
The content variants to load in the player. Possible values are article and summary. The default is ["article"]
article, summary The user interface mode of the player. Possible values are audio, audio-agent, or agent. The default is audio
audio, audio-agent, agent The user interface mode of the widget. Possible values are auto, audio, audio-agent, or agent. The auto mode follows the embed_mode of the player. The default is auto
auto, audio, audio-agent, agent Whether voice conversations with the agent are enabled in the player. The default is true
Response
OK
Whether the player distribution is on or off
The player version to use. Possible values are 0 for legacy and 1 for the current
0, 1 The style of user interface to show for the player. Possible values are default, small, standard, large, or video
default, small, standard, large, video The title to show in the large player when there isn't a playlist
The text prompt to show on the player
An image to show in the player instead of the content's image
The color theme to use for the player. Possible values are auto, dark, or light The 'auto' theme is based on the user's light/dark mode system preference.
auto, dark, light The dark theme colors
The light theme colors
The video theme colors
Whether to always show the content's title (e.g. instead of the call_to_action)
Whether to show or hide the image in the player
Whether to show clickable ad images in the player when the ad isn't playing
The style of user interface to show for the widget at the bottom of the screen. Possible values are none, small, standard, large, video The widget appears once you scroll past the player in the page.
none, small, standard, large, video The side of the screen on which to show the widget. Possible values are auto, left, center, right The 'auto' position places the standard player in the center, otherwise to the right.
auto, left, center, right Whether to allow playback by clicking on a segment (i.e. a paragraph) on the page
Whether segments should be highlighted in time with content playback
The style of skip buttons to show in the player. Possible values are segments or seconds You can specify the number of seconds to skip, e.g. seconds-15 or seconds-15-30
The URLs of intros and outros audio files
The URL of an intro audio file to play before all content in the player
The URL of an outro audio file to play after all content in the player
Whether or not the intro and outro should be played. The default is false
Whether to show a download button next to each playlist item in the player.
Whether to show the BeyondWords logo in the player.
Analytics enabled.
Analytics uuid enabled.
Analytics server URL
Custom analytics server URL
Analytics ID
Analytics tag enabled
Google Analytics tag
Time at which the object was updated (ISO 8601)
The continuous playback mode. Possible values are none or recent
none, recent The outro playback mode. Possible values are after-all or after-each
after-all, after-each The corner radius of the player, in pixels. The default is 8. Only affects players with the default player_style
The hexadecimal accent color to use in the player. Only affects players with the default player_style
The hexadecimal text color to use on accented elements in the player. Only affects players with the default player_style
The disclosure text to show in the player. Only affects players with the default player_style
The URL the disclosure text links to. Only affects players with the default player_style
The hexadecimal color to use for the agent user interface in the player
The URL of an avatar image to show for the agent in the player
The placeholder text to show in the agent input field in the player
Suggested prompts to show in the agent user interface in the player. The default is an empty array
The informational text to show in the agent user interface in the player
The content variants to load in the player. Possible values are article and summary. The default is ["article"]
article, summary The user interface mode of the player. Possible values are audio, audio-agent, or agent. The default is audio
audio, audio-agent, agent The user interface mode of the widget. Possible values are auto, audio, audio-agent, or agent. The auto mode follows the embed_mode of the player. The default is auto
auto, audio, audio-agent, agent Whether voice conversations with the agent are enabled in the player. The default is true