Actualizar un vídeo

Actualizar un vídeo requiere el permiso videos.update. visibility solo se escribe cuando la clave tiene videos.publish. Si no, el campo permanece sin cambios y la respuesta sigue siendo 200. Consulta Autenticación.

Actualizar vídeo

Para actualizar un único vídeo, envía una solicitud PATCH al endpoint /videos/:id.

Si buscas una forma de reemplazar un archivo de vídeo, consulta la sección reemplazar vídeo.

Campos editables

Campo	Notas
`title`	Obligatorio si se envía. Se recorta. De 1 a 150 caracteres.
`description`	Máximo 2000 caracteres.
`language`	Configuración regional del idioma hablado, por ejemplo `en-US`. También se almacenan otras cadenas.
`aiContent`	`none`, `generated` o `modified`.
`visibility`	Solo se escribe con `videos.publish`. Si no, el campo permanece sin cambios.
`categories`	Sustituye la lista. Los ids desconocidos se descartan. Si no queda ninguno, el campo es `null`.
`tags`	Sustituye la lista. Los ids desconocidos se descartan. Si no queda ninguno, el campo es `null`.
`customMetadata`	Se fusiona con el objeto almacenado. Consulta el objeto de video.
`chapters`	`title` (máx. 100) y `timestamp` como `HH:MM:SS`.
`autoTranscription.autoStart`	Inicia la transcripción después de la siguiente codificación cuando es `true`.
`player.useCustomDesign`	Usa `player.playerDesign` en lugar del preset.
`player.selectedPreset`	Id del preset del reproductor, o `null`.
`player.playerDesign`	Propiedades de diseño del reproductor. Consulta el objeto de video.
`passwordProtection`	`{ enabled, password }`. `password` tiene al menos 8 caracteres. Solo se escribe cuando el espacio de trabajo tiene protección por contraseña.

status, texttracks, audiotracks y los campos de archivo se ignoran. Envía los cambios de text track a los endpoints de text track.

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'
  ]
]);

Respuesta

La respuesta es un objeto que contiene el objeto Video y un mensaje de actualización. Si el id no existe, la respuesta es 403 con el error de Payload. Un id ausente y un id prohibido devuelven el mismo cuerpo. Consulta Autenticación.


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