Customizations

Update Appearance Customizations

Changed on

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 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/appearance

Request

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

Path parameters

mediaIdstring required

The hashed ID of the video to be customized.

Headers

X-Wistia-API-Versionstring required

Request body

playerColorstring

Base color of the player as a hexadecimal RGB string (no leading '#').

roundedPlayerinteger

Corner radius of the player in pixels. 0 disables rounding.

opaqueControlsboolean

If true, player controls render on an opaque background.

contrastIconsboolean

If true, control icons use a higher-contrast treatment.

brandingboolean

If false, Wistia branding is hidden on the player.

showCustomerLogoboolean

If true, your customer logo is shown on the player.

customerLogoImageUrlstring

URL of the customer logo image to display on the player.

customerLogoTargetUrlstring

URL the customer logo links to when clicked.

customerLogoPlacementstring

Placement of the customer logo on the player (e.g. top-right).

customerLogoSizePercentinteger

Size of the customer logo as a percentage of the player.

Example request

{
  "playerColor": "2949E5"
}

Response

Appearance customization update successful

playerColorstring
roundedPlayerstring
opaqueControlsstring
contrastIconsstring
brandingstring
showCustomerLogostring
customerLogoImageUrlstring
customerLogoTargetUrlstring
customerLogoPlacementstring
customerLogoSizePercentstring

Changes