Sign in
Videos

Update a discarded video object

Restore a discarded video

patch/discarded/videos/{videoId}

Path parameters

videoIdstring required

The video ID for the video you want to restore.

Request body

discardedboolean

Use this parameter to restore a discarded video when you have the Video Restore feature enabled. This parameter only accepts false as a value!

Example request

{
  "discarded": false
}

Response

Success

videoIdstring required

The unique identifier of the video object.

createdAtstring date-time

When a video was created, presented in ATOM UTC 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 ATOM UTC format.

updatedAtstring date-time

The date and time the video was updated. Date and time are provided using ATOM UTC format.

discardedAtstring date-time nullable

The date and time the video was discarded. The API populates this field only if you have the Video Restore feature enabled and discard a video. Date and time are provided using ATOM UTC format.

deletesAtstring date-time nullable

The date and time the video will be permanently deleted. The API populates this field only if you have the Video Restore feature enabled and discard a video. Discarded videos are pemanently deleted after 90 days. Date and time are provided using ATOM UTC format.

discardedboolean

Returns true for videos you discarded when you have the Video Restore feature enabled. Returns false for every other video.

languagestring

Returns the language of a video in IETF language tag format. You can set the language during video creation via the API, otherwise it is detected automatically.

languageOrigin'api' | 'auto' nullable

Returns the origin of the last update on the video's language attribute.

  • api means that the last update was requested from the API.
  • auto means that the last update was done automatically by the API.
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",
  "language": "en",
  "languageOrigin": "api",
  "tags": [
    "maths",
    "string theory",
    "video"
  ],
  "metadata": [
    {
      "key": "Author",
      "value": "John Doe"
    },
    {
      "key": "Format",
      "value": "Tutorial"
    }
  ],
  "createdAt": "2024-03-03T12:52:03+00:00",
  "publishedAt": "2024-07-14T23:36:07+00:00",
  "discarded": false,
  "discardedAt": null,
  "deletesAt": null,
  "actions": [
    "video_delete",
    "video_download",
    "video_update"
  ]
}

Changes

Changed in 3 of the 50 revisions of this API.13

  • ac1f7d2cfd032See the full diff
    • ○

      added the optional property language to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property languageOrigin to the response with the 200 status

      response-optional-property-added

  • e68c2c97ad651See the full diff
    • ○

      endpoint added

      endpoint-added

  • 2a4d90a64f881See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 32 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 50 revisions, 1 has no diff computed.