Update

put

https://api.beyondwords.io/v1/projects/{project_id}/player_settings

Updates the player settings for a project

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

project_id

string

required

The numeric ID of your project

Body Params

enabled

boolean

Whether the player distribution is on or off

player_version

string

enum

The player version to use. Possible values are 0 for legacy and 1 for the current

Allowed:

player_style

string

enum

he style of user interface to show for the player. Possible values are small, standard, large, or video

Allowed:

player_title

string | null

The title to show in the large player when there isn't a playlist

call_to_action

string

The text prompt to show on the player

image_url

string | null

An image to show in the player instead of the content's image

persistent_ad_image

boolean | null

Whether to show clickable ad images in the player when the ad isn't playing

theme

string

enum

The color theme to use for the player. The color theme to use for the player. Possible values are auto, dark, or light

Allowed:

dark_theme

object

The dark theme colors

light_theme

object

The light theme colors

video_theme

object

The video theme colors

title_enabled

boolean

Whether to always show the content's title (e.g. instead of the call_to_action)

image_enabled

boolean

Whether to show or hide the image in the player

widget_style

string

enum

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.

Allowed:

widget_position

string

enum

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.

Allowed:

segment_playback_enabled

boolean

Whether to allow playback by clicking on a segment (i.e. a paragraph) on the page Support for this depends on adding some markup into the HTML of the page.

skip_button_style

string

The style of skip buttons to show in the player. Possible values are auto, segments, seconds or audios You can specify the number of seconds to skip, e.g. seconds-15 or seconds-15-30 The auto style uses audios if there is a playlist and segments otherwise.

intro_url

string | null

The URL of an intro audio file to play before all content in the player

outro_url

string | null

The URL of an outro audio file to play after all content in the player.

intro_outro_enabled

boolean

Whether or not the intro and outro should be played. The default is false

paywall_type

string

The style of paywall to apply to the player. Possible values are none, show, hide or lock You can specify the number of body segments to make listenable, e.g. show-3

paywall_url

string | null

The URL to link to when the content is paywalled, e.g. a signup page

download_button_enabled

boolean

Whether to show a download button next to each playlist item in the player

share_button_enabled

boolean

Whether to show a share button in the player

voice_icon_enabled

boolean

Whether to show an icon stating that the voice was AI generated in the player

analytics_custom_url

string | null

Custom analytics server URL

analytics_tag_enabled

string | null

Google Analytics tag enabled

analytics_tag

string | null

Google Analytics tag

logo_icon_enabled

boolean

Whether to show the BeyondWords logo in the player

Response

200OK