Update Accessibility Customizations

Applies a partial update to a video's accessibility 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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The hashed ID of the video to be customized.

Body Params

Accessibility customizations for a video: caption display & styling,
transcript display, and audio description. Every field is optional; only the
fields you send are changed (partial update). Send a field as null to reset
it to its default.

string

Background color of the captions as a hexadecimal RGB string (no leading '#').

integer

Corner radius of the captions background in pixels.

string

Color of the captions text as a hexadecimal RGB string (no leading '#').

integer

Size of the captions text in pixels.

string

Font family used for the captions text.

boolean

If true, the interactive transcript is shown alongside the video.

boolean

If true, speaker labels are displayed in the transcript.

boolean

If true, the audio description control is available to viewers.

plugin
object
Headers
string
required
Defaults to 2026-09
Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json