POST https://api.vidyard.com/dashboard/v1/players/uuid=:uuid/embed_codes
Create a player embed codes by UUID (supports email personalization)

Also see "POST player embed codes" for examples.

Create a player embed codes by UUID (supports email personalization). Any parameter not specified will default to the settings chosen for the player.

Supported Formats

json

Errors

Code Description
400 Bad Request: body has wrong syntax or unable to handle request
401 Unauthorized: auth_token omitted or authentication failed
403 Forbidden: This action cannot be performed
404 Not Found: The requested resource could not be found
406 Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Params

Param name Description
auth_token
optional

API token needed to authorize requests
This can appear as an attribute in the body of the request or the query parameters on the URL

Validations:

  • Must be a String
uuid
required

Validations:

  • Must be a String
vyemail
optional

Personalizes the embed codes to the given email (will add vyetoken representing the email).

Validations:

  • Must be a String
custom_id
optional

When specified (and applicable) will load the specified instance of the player
Default: empty

Validations:

  • Must be a String
disable_popouts
optional

Turns off Popout Call to Actions so they will not display in the player
Default: false

Validations:

  • Parameter has to be Boolean.
disable_redirect
optional

Disable the player from redirecting if it is set to redirect on player completion
Default: false

Validations:

  • Parameter has to be Boolean.
up_next
optional

Turn off showing what’s Up next, only available if playlist_always_open is false
Default: false

Validations:

  • Parameter has to be Boolean.
disable_playlist
optional

Turn off the Playlist so it will not be displayed
Default: false

Validations:

  • Parameter has to be Boolean.
playlist_always_open
optional

If there are multiple chapters in the player the playlist will be permanently visible
Default: player setting

Validations:

  • Parameter has to be Boolean.
autoplay
optional

Causes the playlist to begin playing as soon as it has loaded
Default: player setting

Validations:

  • Parameter has to be Boolean.
control_360
optional

Show 360 controls for a 360 videos
Default: true

Validations:

  • Parameter has to be Boolean.
first_frame
optional

Causes the player to begin playing as soon as it has loaded and then immediately pause
Default: player setting

Validations:

  • Parameter has to be Boolean.
viral_sharing
optional

Displays the social sharing buttons on the player
Default: player setting

Validations:

  • Parameter has to be Boolean.
embed_button
optional

Displays the embed button on the player
Default: player setting

Validations:

  • Parameter has to be Boolean.
hide_playlist
optional

Disables the playlist in the player
Default: false

Validations:

  • Parameter has to be Boolean.
hide_html5_playlist
optional

Disables the HTML5 playlist. This can be useful to solve problems with iOS and when the playlist is causing page alignment issues.
Default: false

Validations:

  • Parameter has to be Boolean.
name_overlay
optional

Overlays the name of the video at the top of the player
Default: player setting

Validations:

  • Parameter has to be Boolean.
video_id
optional

When specified the player will begin playing the video with this video id first, otherwise the player will play the chapters in chapter order. The video_id specified must already exist in the playlist. The video_id property should not be set at the same time as the chapter property.

Validations:

  • Parameter has to be Integer.
chapter
optional

When specified the player will begin playing the chapter with this ordinal value i.e. the value 1 would play the first chapter, otherwise the player will play the chapters in chapter order. The chapter property should not be set at the same time as the video_id property.

Validations:

  • Parameter has to be Integer.
lightbox_href_text
optional

The text to used in in the embed code for lightbox
Default: <Thumbnail with play button>

Validations:

  • Must be a String
include_sharing_page
optional

Whether or not to include the embed code for the sharing page
Default: true

Validations:

  • Parameter has to be Boolean.
include_branded_sharing_page
optional

Whether or not to include the embed code for the branded sharing page
Default: false

Validations:

  • Parameter has to be Boolean.