Update Customizations
update_customizationsPartially update a video's customizations: set new values or delete existing keys by passing null. Requires confirm=true.
Instructions
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 anythingTokens 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.
Requires confirm=true for the requested mutation. May share access, notify people or incur provider charges.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| seo | No | If set to true, the video’s metadata will be injected into the page’s markup for SEO. | |
| time | No | Sets the starting time of the video. | |
| No | Associate a specific email address with this video’s viewing sessions. | ||
| muted | No | If set to true, the video will start in a muted state. | |
| wmode | No | If set to transparent, the background behind the player will be transparent instead of black. | |
| plugin | No | ||
| volume | No | Sets the volume of the video. | |
| account | No | Named private Wistia account; selects credentials, not a remote account ID. | |
| confirm | No | Must be true for the specific user-requested write. | |
| payload | No | Complete JSON request body instead of body flags. Supports current nested customization, caption and nullable values. | |
| playbar | No | If set to true, the playbar will be available. If set to false, it will be hidden. | |
| preload | No | Sets the video’s preload property. Possible values are metadata, auto, none, true, and false. | |
| autoPlay | No | 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. | |
| media_id | Yes | The hashed ID of the video to be customized. | |
| stillUrl | No | Overrides the thumbnail image that appears before the video plays. | |
| resumable | No | Determines if the video should resume from where the viewer left off. Options are true, false, and auto. | |
| videoFoam | No | 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. | |
| doNotTrack | No | If set to true, data for each viewing session will not be tracked. | |
| keyMoments | No | If set to false, the key moments feature will be disabled. | |
| playButton | No | Indicates if the play button is visible. | |
| qualityMax | No | Specifies the maximum quality the video will play at. | |
| qualityMin | No | Specifies the minimum quality the video will play at. | |
| fitStrategy | No | 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. | |
| playerColor | No | Changes the base color of the player. Expects a hexadecimal rgb string. | |
| playsinline | No | If set to false, videos will play within the native mobile player. | |
| payload_file | No | Regular local JSON body file, at most 5 MB. Cannot be mixed with body flags or payload. | |
| playlistLoop | No | If set to true and this video has a playlist, it will loop back to the first video after the last one has finished. | |
| playlistLinks | No | Enables the use of specially crafted links on the page to associate with a video, turning them into a playlist. | |
| volumeControl | No | When set to true, a volume control is available over the video. | |
| fakeFullscreen | No | If set to true, the video will try to play in a pseudo-fullscreen mode on certain mobile devices. | |
| qualityControl | No | If set to false, the video quality selector in the settings menu will be hidden. | |
| silentAutoPlay | No | Determines how videos handle autoplay in contexts where normal autoplay might be blocked. Options are true, allow, and false. | |
| settingsControl | No | If set to true, the settings control will be available. | |
| smallPlayButton | No | ||
| endVideoBehavior | No | 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). | |
| fullscreenButton | No | If set to true, the fullscreen button will be available as a video control. | |
| thumbnailAltText | No | Sets the Thumbnail Alt Text for the media. | |
| playPauseNotifier | No | If set to false, animations for the Pause and Play symbols will be removed. | |
| playbackRateControl | No | If set to false, the playback speed controls in the settings menu will be hidden. | |
| controlsVisibleOnLoad | No | If set to true, controls like the big play button, playbar, volume, etc. will be visible as soon as the video is embedded. | |
| playSuspendedOffScreen | No | If set to false for a muted autoplay video, the video won't pause when out of view. | |
| copyLinkAndThumbnailEnabled | No | If set to false, the option to “Copy Link and Thumbnail” will be removed when right-clicking on the video. | |
| fullscreenOnRotateToLandscape | No | If set to false, the video will not automatically go to fullscreen mode on mobile when rotated to landscape. |