Update a 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
422 Unprocessable Entity: body has wrong attributes

Examples

REQUEST
Content-Type: application/json
{
  "play_button": false,
  "autoplay": true,
  "mute_onload": true,
  "embed_button": false,
  "whitelisted_embed_domain": "*.example.com"
}

RESPONSE
200 (OK)
{
  "id": 1111,
  "uuid": "eQSsPVXinqGoesujP2Vteg",
  "name": "My Player",
  "description": "The besterest videos",
  "play_button": false,
  "autoplay": true,
  "hd_button": true,
  "default_hd": true,
  "embed_button": false,
  "viral_sharing": true,
  "viral_sharing_message": "Check out this awesome video!",
  "custom_sharing_link": null,
  "height": 360,
  "width": 640,
  "color": "A7A7A7",
  "playlist_color": "222222",
  "splash_screen_fade": true,
  "mute_onload": true,
  "playlist_always_open": false,
  "audio_player_visuals": "visualization",
  "on_complete": "loop",
  "redirect_url": null,
  "redirect_whole_page": false,
  "sharing_page": true,
  "sharing_page_comments": true,
  "release_date": 0,
  "whitelisted_embed_domain": "*.example.com",
  "chapters_attributes":[{
    "position":0,
    "player_id":50,
    "video_id":63,
    "video_attributes":{
      "name":"Falcon Punch",
      "upload_url":null,
      "description":"A description",
      "sync":true,
      "audio_gain":0,
      "webhook_url":null,
      "tags_attributes":[],
      "hosting_provider":"youtube",
      "id":63,
      "status":null,
      "error_message":null,
      "created_at":1374178204,
      "updated_at":1374178204
    },
    "id":37,
    "created_at":1374178204,
    "updated_at":1374178204
  }],
  "created_at": 1390585689,
  "updated_at": 1390585689,
  "length_in_seconds": 0,
  "show_playback_speed": false
}

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

id
required

Validations:

  • Parameter has to be Integer.

name
optional

Name of the player

Validations:

  • Must be a String

description
optional

Description of the player

Validations:

  • Must be a String

play_button
optional

Display the play button on the thumbnail

Validations:

  • Parameter has to be Boolean.

autoplay
optional

Force the player to start playing when the page loads

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.

hd_button
optional

Display the HD button on the player controls allowing viewers to toggle the quality of the videos

Validations:

  • Parameter has to be Boolean.

default_hd
optional

Playback automatically set to the highest quality

Validations:

  • Parameter has to be Boolean.

embed_button
optional

Display embed button on player

Validations:

  • Parameter has to be Boolean.

viral_sharing
optional

Adds a share button to your player allowing your viewers to share your videos on social networks and email

Validations:

  • Parameter has to be Boolean.

viral_sharing_message
optional

The message used when viral sharing button is clicked

Validations:

  • Must be a String

custom_sharing_link
optional

The link that will be shared when viral sharing button is clicked
Default: Users will share the page where the player is embedded

Validations:

  • Must be a String

height
optional

Height of the player

Validations:

  • Parameter has to be Integer.

width
optional

Width of the player

Validations:

  • Parameter has to be Integer.

color
optional

Color of the player (Hex)
Eg. “FFFFFF”, “000000”, “55B020” etc.

Validations:

  • Must be a String

playlist_color
optional

Color of the playlist (Hex)
Eg. “FFFFFF”, “000000”, “55B020” etc.

Validations:

  • Must be a String

splash_screen_fade
optional

The player gets highlighted when a viewer’s mouse hovers over it

Validations:

  • Parameter has to be Boolean.

mute_onload
optional

The videos will default to mute with a text overlay prompting the viewer to click for sound

Validations:

  • Parameter has to be Boolean.

playlist_always_open
optional

The playlist is always shown on the side of the player
Adds 319 pixels to the width of the player

Validations:

  • Parameter has to be Boolean.

on_complete
optional , nil allowed

What would you like to happen when all videos have finished playing?
“splash_screen”: (Default) Shows the thumbnail again
“loop”: Loop the playback
“redirect_url”: redirect to the url you set in “redirect_url”

Validations:

  • Must be one of: splash_screen, loop, redirect_url, final_frame, .

redirect_url
optional

URL to redirect the player iframe to when videos have finished playing
Will only redirect if “on_complete” is set to “redirect_url”

Validations:

  • Must be a String

redirect_whole_page
optional

Redirects the entire page if “on_complete” is set to “redirect_url”

Validations:

  • Parameter has to be Boolean.

sharing_page
optional

Enable the sharing page for the player

Validations:

  • Parameter has to be Boolean.

sharing_page_comments
optional

Allow viewers to comment on the sharing page

Validations:

  • Parameter has to be Boolean.

release_date
optional

Timestamp (Unix Time)

Validations:

  • Parameter has to be TimeStamp.

whitelisted_embed_domain
optional

Restrict this player to be embedded only on specific domains
We will automatically match www.example.com, example.com variations and http, https variations.
Any subdomains will be matched if you enter *.example.com

Validations:

  • Must be a String

authorized_by
optional

Restrict this player to a specific platform such as Hubs or Salesforce Chatter

Validations:

  • Must be one of: platform, .

hidden_controls
optional

Disable playback controls

Validations:

  • Parameter has to be Boolean.

up_next
optional

Enable Up Next feature

Validations:

  • Parameter has to be Boolean.

disable_live_dvr
optional

Disable live stream DVR

Validations:

  • Parameter has to be Boolean.

disable_legacy
optional

Disable legacy mode

Validations:

  • Parameter has to be Boolean.

audio_player_visuals
optional

Change what is displayed during playback of an audio chapter

Validations:

  • Must be one of: splash screen, visualization, none.