Update a video

Updating a video requires the videos.update permission. visibility is written only when the key has videos.publish. Otherwise the field stays unchanged and the response stays 200. See Authentication.

Update video

Updating a single video is done by sending a PATCH request to the /videos/:id endpoint.

If you are looking for a way to replace a video file, please refer to the replace video section.

Writable fields

Field	Notes
`title`	Required when sent. Trimmed. 1 to 150 characters.
`description`	Maximum 2000 characters.
`language`	Spoken-language locale, for example `en-US`. Other strings are stored as well.
`aiContent`	`none`, `generated`, or `modified`.
`visibility`	Written only with `videos.publish`. Otherwise the field stays unchanged.
`categories`	Replaces the list. Unknown ids are dropped. If none remain, the field is `null`.
`tags`	Replaces the list. Unknown ids are dropped. If none remain, the field is `null`.
`customMetadata`	Merges onto the stored object. See the video object.
`chapters`	`title` (max 100) and `timestamp` as `HH:MM:SS`.
`autoTranscription.autoStart`	Start transcription after the next encode when `true`.
`player.useCustomDesign`	Use `player.playerDesign` instead of the preset.
`player.selectedPreset`	Player preset id, or `null`.
`player.playerDesign`	Player design properties. See the video object.
`passwordProtection`	`{ enabled, password }`. `password` is at least 8 characters. Written only when the workspace has password protection.

status, texttracks, audiotracks, and file fields are ignored. Send text track changes to the text track endpoints.

CURL


curl -X PATCH https://app.ignitevideo.cloud/api/videos/[VIDEO_ID] \ 
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{"title": "New video title"}'

JavaScript / Node.js


const dataToUpdate = {
  "title": "New video title"
}
const response = await fetch(`https://app.ignitevideo.cloud/api/videos/[VIDEO_ID]`, {
  method: 'PATCH',
  body: JSON.stringify(dataToUpdate),
  headers: {
    'Authorization': `Bearer YOUR_TOKEN`,
    'Content-Type': 'application/json'
  }
});

PHP


$client = new GuzzleHttp\Client();
$dataToUpdate = [
  "title" => "New video title"
];
$response = $client->request('PATCH', 'https://app.ignitevideo.cloud/api/videos/[VIDEO_ID]', [
  'body' => json_encode($dataToUpdate),
  'headers' => [
    'Authorization' => 'Bearer YOUR_TOKEN',
    'Content-Type' => 'application/json'
  ]
]);

Response

The response is an object containing the Video object and an update message. If the id does not exist, the response is 403 with the Payload error. A missing id and a forbidden id return the same body. See Authentication.


{
  doc: {
    "id": "[VIDEO_ID]",
    "title": "New video title",
    ...
  },
  message: "Updated successfully."
}