API Reference
Wistia Learning CenterWistia
Start typing to search…

Update Customizations

put
https://api.wistia.com/modern/medias//customizations

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
Path Params
string
required

The hashed ID of the video to be customized.

Body Params
boolean

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.

boolean

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

boolean

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

boolean

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

string

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

string

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).

boolean

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

string

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.

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

Indicates if the play button is visible.

string

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

plugin
object
string

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

boolean

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

integer

Specifies the maximum quality the video will play at.

integer

Specifies the minimum quality the video will play at.

string

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

boolean

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

boolean

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

string

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

boolean
string

Overrides the thumbnail image that appears before the video plays.

string

Sets the starting time of the video.

string

Sets the Thumbnail Alt Text for the media.

When set to true, the video will adjust its size according to its parent element. It can also be an object specifying min/max width or height.

number

Sets the volume of the video.

boolean

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

string

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

Headers
string
required
Defaults to 2026-03
Responses

Updated about 1 month ago

Language
Credentials
Bearer
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated about 1 month ago