API de vídeosGuías
Actualizar llamadas a la acción
Crea, edita y elimina los CTA que aparecen sobre o debajo del vídeo.
call_actions tiene un interruptor de funcionalidad, enabled, por encima de la
lista items que habilita. La lista se combina por elemento: un elemento con un
id modifica ese CTA, un elemento sin él crea un CTA nuevo, y un elemento
con "_destroy": true lo elimina. Los CTA que no mencionas se quedan como están.
Esto es un merge-patch: envía solo las claves que quieres cambiar y todo lo demás conserva su valor guardado.
Edita un CTA, crea otro y elimina un tercero
curl -X PATCH https://api.vturb.com/v1/videos/{id} \
-H "Authorization: Bearer vt_..." \
-H "Content-Type: application/json" \
-d '{ "call_actions": {
"enabled": true,
"items": [
{ "id": "66f2...", "window": { "start": 30 } },
{ "base": { "name": "Buy now", "type": "outside_video", "active": true },
"window": { "start": 60, "end": 120 } },
{ "id": "66f3...", "_destroy": true }
]
} }'El interruptor de la funcionalidad
| Clave | Tipo | Define |
|---|---|---|
enabled | booleano | Activa o desactiva toda la funcionalidad de CTA (está junto a items) |
Las claves de cada elemento (dentro de items)
| Clave | Tipo | Define |
|---|---|---|
id | string | Apunta a un CTA existente; omítelo para crear uno |
_destroy | booleano | true elimina el CTA al que apunta el id |
base.name | string | Etiqueta interna — solo se acepta cuando action.as_html o image_as_button está definido; en un botón de texto, la etiqueta es el content |
base.type | string | inside_video (sobre el reproductor) o outside_video (debajo de él) |
base.active | booleano | Activa o desactiva el CTA |
window.start | entero | Segundo en el que aparece el CTA |
window.end | entero | Segundo en el que desaparece el CTA |
window.persist_on_video_end | booleano | Mantiene el CTA visible después de que termina el vídeo |
action.content | string | Texto de la etiqueta del botón (la vía estructurada, sin HTML) |
action.url | string | URL http(s) que abre el CTA |
action.open_in_new_tab | booleano | Abre la URL en una pestaña nueva |
action.html | string | HTML personalizado que renderiza el CTA (requiere action.as_html) |
action.as_html | booleano | Trata el contenido como HTML sin procesar |
design.typography | objeto | Fuente de un botón de texto: family, letter_spacing, line_height, size, weight |
design.styles | objeto | Aspecto de un botón de texto: los colores, border_radius, padding, shadow |
Un botón de texto (sin action.as_html ni image_as_button) requiere action.content,
action.url y un design.typography + design.styles completos. Dentro de un elemento, la
combinación sigue siendo superficial por grupo: modificar window.start no toca window.end.