HomeTutorialsAPI ReferenceStatus
API Reference
Start typing to search…

Update Video

put
https://{APP_DOMAIN}/api/3.2/contents/videos/

Updates an existing video. The publication cannot be changed after creation. When active and show_on_website are both true, you must provide the ranks array with all videos for the publication to set display order.

Path Params
integer
required

The id of the video

Body Params

Body Params

boolean
required

Whether the Video is active. Used to disable videos from being linked to if you know the url.

ranks
array of objects
required

The rank of the Video and other related Videos to be used when determining position of the Video on the website. It is up to you to sync the ranks of the Videos before submitting the request. OptiPub does not assume how you would like to rank your Videso. It is recommended to update all of the Videos related to the same Publication at the same time to avoid duplicate ranks or inconsistent numbering.

ranks*
string
required

The title of the video.

string
required

The description of the video.

string

A blurb of information that is displayed above the video on client-facing websites.

string

A blurb of information that is displayed below the video on client-facing websites.

boolean
required

Whether the video is displayed on client-facing websites by default.

player
object
required

Must be 'youtube', 'video.js', or 'wistia'. Used to determine which video player the video plays on.

player_data
array of strings
required

Data required to load the video from the selected player. See notes.

player_data*
integer
required

ID of an image to be used at the Video thumbnail.

integer
required

The ID of the publication this video is being created for.

string
Response

Updated 18 days ago

Language
Credentials
Bearer
JWT
URL
Response 
 Choose an example:
application/json
Updated 18 days ago