Sign in
Videos

Update a video object

Update the parameters associated with a video ID.

patch/videos/{videoId}

Path parameters

videoIdstring required

The video ID for the video you want to update.

Request body

playerIdstring

The unique ID for the player you want to associate with your video.

titlestring

The title you want to use for your video.

descriptionstring

A brief description of the video.

publicboolean

Whether the video is publicly available or not. False means it is set to private. Default is true. Tutorials on private videos.

panoramicboolean

Whether the video is a 360 degree or immersive video.

mp4Supportboolean

Whether the player supports the mp4 format.

tagsstring[]

A list of terms or words you want to tag the video with. Make sure the list includes all the tags you want as whatever you send in this list will overwrite the existing list for the video.

Example request

{
  "playerId": "pl45KFKdlddgk654dspkze",
  "title": "String theory",
  "description": "An amazing video explaining the string theory",
  "public": false,
  "panoramic": false,
  "mp4Support": true,
  "tags": [
    "maths",
    "string theory",
    "video"
  ],
  "metadata": [
    {
      "key": "Author",
      "value": "John Doe"
    },
    {
      "key": "Format",
      "value": "Tutorial"
    }
  ]
}

Response

Success

videoIdstring required

The unique identifier of the video object.

createdAtstring date-time

When a video was created, presented in ISO-8601 format.

titlestring

The title of the video content.

descriptionstring

A description for the video content.

publishedAtstring date-time

The date and time the API created the video. Date and time are provided using ISO-8601 UTC format.

updatedAtstring date-time

The date and time the video was updated. Date and time are provided using ISO-8601 UTC format.

tagsstring[]

One array of tags (each tag is a string) in order to categorize a video. Tags may include spaces.

playerIdstring

The id of the player that will be applied on the video.

publicboolean

Defines if the content is publicly reachable or if a unique token is needed for each play session. Default is true. Tutorials on private videos.

panoramicboolean

Defines if video is panoramic.

mp4Supportboolean

This lets you know whether mp4 is supported. If enabled, an mp4 URL will be provided in the response for the video.

Example response

{
  "videoId": "vi4k0jvEUuaTdRAEjQ4Jfrgz",
  "title": "Maths video",
  "description": "An amazing video explaining the string theory",
  "tags": [
    "maths",
    "string theory",
    "video"
  ],
  "metadata": [
    {
      "key": "Author",
      "value": "John Doe"
    },
    {
      "key": "Format",
      "value": "Tutorial"
    }
  ],
  "createdAt": "4251-03-03T12:52:03.085Z",
  "publishedAt": "4665-07-14T23:36:18.598Z",
  "actions": [
    "video_delete",
    "video_download",
    "video_update"
  ]
}

Changes