WIwistia
Customizations

Update Customizations

Changed on

Allows for partial updates on a video’s customizations. If a value is null, then that key will be deleted from the saved customizations. If it is not null, that value will be set.

Requires api token with one of the following permissions

Read, update & delete anything

Tokens with the "Act with a team member's permissions" permission (all:delegate_to_contact_permissions scope) can also be used. Requests made with such a token are authorized using the permissions of the contact assigned to the token.

An expiring access token created with the all:delegate_to_contact_permissions scope and an authorization granting the edit permission on this media can also be used.

put/medias/{mediaId}/customizations

Request

  • Base URL
    https://api.wistia.com/modern
  • URL
    https://api.wistia.com/modern/medias/{mediaId}/customizations
  • Auth
    HTTP bearer

Path parameters

mediaIdstring required

The hashed ID of the video to be customized.

Headers

X-Wistia-API-Versionstring required

Request body

autoPlayboolean

If set to true, the video will play as soon as it’s ready. Note that autoplay might not work on some devices and browsers.

controlsVisibleOnLoadboolean

If set to true, controls like the big play button, playbar, volume, etc. will be visible as soon as the video is embedded.

copyLinkAndThumbnailEnabledboolean

If set to false, the option to “Copy Link and Thumbnail” will be removed when right-clicking on the video.

doNotTrackboolean

If set to true, data for each viewing session will not be tracked.

emailstring

Associate a specific email address with this video’s viewing sessions.

endVideoBehaviorstring

Determines what happens when the video ends. Options are default (stays on the last frame), reset (shows thumbnail and controls), and loop (plays again from the start).

fakeFullscreenboolean

If set to true, the video will try to play in a pseudo-fullscreen mode on certain mobile devices.

fitStrategystring

Resizes the video when there's a discrepancy between its aspect ratio and that of its parent container. Options are contain, cover, fill, and none.

fullscreenButtonboolean

If set to true, the fullscreen button will be available as a video control.

fullscreenOnRotateToLandscapeboolean

If set to false, the video will not automatically go to fullscreen mode on mobile when rotated to landscape.

keyMomentsboolean

If set to false, the key moments feature will be disabled.

mutedboolean

If set to true, the video will start in a muted state.

playbackRateControlboolean

If set to false, the playback speed controls in the settings menu will be hidden.

playbarboolean

If set to true, the playbar will be available. If set to false, it will be hidden.

playButtonboolean

Indicates if the play button is visible.

playerColorstring

Changes the base color of the player. Expects a hexadecimal rgb string.

playlistLinksboolean

Enables the use of specially crafted links on the page to associate with a video, turning them into a playlist.

playlistLoopboolean

If set to true and this video has a playlist, it will loop back to the first video after the last one has finished.

playsinlineboolean

If set to false, videos will play within the native mobile player.

playPauseNotifierboolean

If set to false, animations for the Pause and Play symbols will be removed.

playSuspendedOffScreenboolean

If set to false for a muted autoplay video, the video won't pause when out of view.

preloadstring

Sets the video’s preload property. Possible values are metadata, auto, none, true, and false.

qualityControlboolean

If set to false, the video quality selector in the settings menu will be hidden.

qualityMaxinteger

Specifies the maximum quality the video will play at.

qualityMininteger

Specifies the minimum quality the video will play at.

resumablestring

Determines if the video should resume from where the viewer left off. Options are true, false, and auto.

seoboolean

If set to true, the video’s metadata will be injected into the page’s markup for SEO.

settingsControlboolean

If set to true, the settings control will be available.

silentAutoPlaystring

Determines how videos handle autoplay in contexts where normal autoplay might be blocked. Options are true, allow, and false.

smallPlayButtonboolean
stillUrlstring

Overrides the thumbnail image that appears before the video plays.

timestring

Sets the starting time of the video.

thumbnailAltTextstring

Sets the Thumbnail Alt Text for the media.

volumenumber

Sets the volume of the video.

volumeControlboolean

When set to true, a volume control is available over the video.

wmodestring

If set to transparent, the background behind the player will be transparent instead of black.

Example request

{
  "plugin": {
    "postRoll-v1": {
      "style": {
        "backgroundColor": "#303030"
      },
      "ctaType": "text"
    }
  },
  "videoFoam": true
}

Response

Video customization update successful

playerColorstring

The color of the video player.

stillUrlstring
autoPlaystring

Whether the video should auto play or not.

bpbTimestring
controlsVisibleOnLoadstring
endVideoBehaviorstring

Behavior of the video at the end.

fullscreenButtonstring
brandingstring
playbarstring
playButtonstring

Indicates if the play button is visible.

settingsControlstring
showCustomerLogostring
qualityControlstring
playbackRateControlstring
smallPlayButtonstring
sphericalstring
volumeControlstring
copyLinkAndThumbnailEnabledstring
doNotTrackstring
emailstring
fitStrategystring
fullscreenOnRotateToLandscapestring
mutedstring
playlistLinksstring
playlistLoopstring
playsinlinestring
playPauseNotifierstring
playSuspendedOffScreenstring
preloadstring
qualityMaxstring
qualityMinstring
resumablestring
seostring
silentAutoPlaystring
timestring
thumbnailAltTextstring
videoFoamstring
volumestring
wmodestring
keyMomentsstring

String representation of whether the key moments feature is enabled.

Changes