Sign in

v1

latestOpenAPI 3.0.22026-07-24296786.1 KB
Videos

Update a video

Use the Update a video endpoint to make the video public and accessible via the share page or update its title and description.

patch/v2/videos/{video_id}

Path parameters

video_idstring required

The ID of the video to update

Request body

descriptionstring
titlestring
visibility'private' | 'public'

Response

OK.

callbackIdstring

Use callback ID to link videos back to the initial request. For example, if you are making a personalized video for a customer, you could enter the customer's email as a callback ID. This way, you can tell who the video is for, once its generated..

createdAtinteger

UNIX timestamp representing the time video was created.

descriptionstring

Description of the video to be shown on the share page.

testboolean

Test videos are free and not counted towards your quota. If you create a video in the “test” mode, we will overlay a watermark over your video.

downloadstring
durationstring
idstring uuid
lastUpdatedAtinteger
status'complete' | 'deleted' | 'error' | 'in_progress' | 'rejected' | 'approved'
titlestring

Title of the video to be shown on the share page.

visibility'private' | 'public'

Public videos will be visible to anyone with a share URL.

Private videos can only be downloaded via a time-limited download link. See Retrieve a video for details.

Visibility can be changed also once the video is created via Update a video.