Update Appearance Customizations
update_appearance_customizationsApplies partial updates to a video's player appearance; only supplied fields change and null values revert settings to their defaults.
Instructions
Applies a partial update to a video's appearance customizations. Only the fields supplied are changed; sending a field as null deletes it (reverting to the default).
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 |
|---|---|---|---|
| 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. | |
| branding | No | If false, Wistia branding is hidden on the player. | |
| media_id | Yes | The hashed ID of the video to be customized. | |
| playerColor | No | Base color of the player as a hexadecimal RGB string (no leading '#'). | |
| payload_file | No | Regular local JSON body file, at most 5 MB. Cannot be mixed with body flags or payload. | |
| contrastIcons | No | If true, control icons use a higher-contrast treatment. | |
| roundedPlayer | No | Corner radius of the player in pixels. 0 disables rounding. | |
| opaqueControls | No | If true, player controls render on an opaque background. | |
| showCustomerLogo | No | If true, your customer logo is shown on the player. | |
| playerColorGradient | No | Optional gradient applied to the player color. | |
| customerLogoImageUrl | No | URL of the customer logo image to display on the player. | |
| customerLogoPlacement | No | Placement of the customer logo on the player (e.g. top-right). | |
| customerLogoTargetUrl | No | URL the customer logo links to when clicked. | |
| customerLogoSizePercent | No | Size of the customer logo as a percentage of the player. |