> ## Documentation Index
> Fetch the complete documentation index at: https://voyant.travel/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Update a video

> Updates mutable video fields. At least one field is required. Requires scope: video:upload



## OpenAPI

````yaml /api-specs/services.json patch /video/v1/videos/{videoId}
openapi: 3.1.0
info:
  title: Voyant Cloud REST API
  version: 1.0.0
  description: >-
    Public REST API for Voyant Cloud products: Vault, SMS, Email, Verification,
    Video, Realtime, and Browser. All requests authenticate with an API token
    passed as an HTTP bearer token in the Authorization header. Each operation
    requires a specific token scope, documented in the operation description.
servers:
  - url: https://api.voyant.travel
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Vault
    description: >-
      Encrypted secret storage and envelope/per-call cryptography scoped to an
      organization vault.
  - name: SMS
    description: Send SMS messages and inspect message history and phone numbers.
  - name: Email
    description: Send transactional email and inspect message history.
  - name: Verification
    description: >-
      Start and check one-time-code verifications across SMS, call, email, and
      WhatsApp.
  - name: Video
    description: >-
      Upload, manage, caption, and watermark videos, and mint signed playback
      tokens.
  - name: Realtime
    description: >-
      Publish messages to realtime channels, inspect history and presence, and
      mint short-lived subscriber tokens.
  - name: Browser
    description: >-
      Headless browser rendering, scraping, structured extraction, crawling, and
      interactive sessions.
paths:
  /video/v1/videos/{videoId}:
    patch:
      tags:
        - Video
      summary: Update a video
      description: >-
        Updates mutable video fields. At least one field is required. Requires
        scope: video:upload
      operationId: updateVideo
      parameters:
        - $ref: '#/components/parameters/VideoId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateVideoInput'
      responses:
        '200':
          description: Updated video
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                properties:
                  data:
                    $ref: '#/components/schemas/VideoSummary'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
      x-codeSamples:
        - lang: typescript
          label: SDK
          source: >-
            import { createVoyantCloudClient } from "@voyant-travel/cloud-sdk";


            const cloud = createVoyantCloudClient({ apiKey:
            process.env.VOYANT_API_KEY });


            const video = await cloud.video.videos.update("<videoId>", {
              "name": "<string>",
              "requireSignedUrls": true,
              "allowedOrigins": [
                "<string>"
              ],
              "tags": [
                "<string>"
              ],
              "thumbnailTimestampPct": 123,
              "meta": {}
            });
        - lang: bash
          label: cURL
          source: |-
            curl --request PATCH \
              --url https://api.voyant.travel/video/v1/videos/<videoId> \
              --header 'Authorization: Bearer <token>' \
              --header 'Content-Type: application/json' \
              --data '{
              "name": "<string>",
              "requireSignedUrls": true,
              "allowedOrigins": [
                "<string>"
              ],
              "tags": [
                "<string>"
              ],
              "thumbnailTimestampPct": 123,
              "meta": {}
            }'
        - lang: javascript
          label: Node
          source: >-
            const response = await
            fetch("https://api.voyant.travel/video/v1/videos/<videoId>", {
              method: "PATCH",
              headers: {
                "Content-Type": "application/json",
                "Authorization": "Bearer <token>"
              },
              body: JSON.stringify({
                "name": "<string>",
                "requireSignedUrls": true,
                "allowedOrigins": [
                  "<string>"
                ],
                "tags": [
                  "<string>"
                ],
                "thumbnailTimestampPct": 123,
                "meta": {}
              }),
            });


            const data = await response.json();
        - lang: python
          label: Python
          source: |-
            import requests

            response = requests.patch(
                "https://api.voyant.travel/video/v1/videos/<videoId>",
                headers={
                    "Authorization": "Bearer <token>"
                },
                json={
                    "name": "<string>",
                    "requireSignedUrls": True,
                    "allowedOrigins": [
                        "<string>"
                    ],
                    "tags": [
                        "<string>"
                    ],
                    "thumbnailTimestampPct": 123,
                    "meta": {}
                }
            )

            data = response.json()
components:
  parameters:
    VideoId:
      name: videoId
      in: path
      required: true
      schema:
        type: string
      example: vid_01HZX9Q3J5K8N2P4R6T8V0W2Y4
  schemas:
    UpdateVideoInput:
      type: object
      description: At least one field is required.
      minProperties: 1
      properties:
        name:
          type:
            - string
            - 'null'
          maxLength: 200
        requireSignedUrls:
          type: boolean
        allowedOrigins:
          type: array
          maxItems: 20
          items:
            type: string
            maxLength: 253
        tags:
          type: array
          maxItems: 50
          items:
            type: string
            maxLength: 64
        thumbnailTimestampPct:
          type: number
          minimum: 0
          maximum: 1
        meta:
          type: object
          additionalProperties:
            type: string
            maxLength: 1024
    VideoSummary:
      type: object
      required:
        - id
        - organizationId
        - status
        - readyToStream
        - thumbnailTimestampPct
        - requireSignedUrls
        - allowedOrigins
        - tags
        - downloadStatus
        - meta
        - createdAt
        - updatedAt
      properties:
        id:
          type: string
        organizationId:
          type: string
        providerVideoUid:
          type:
            - string
            - 'null'
        name:
          type:
            - string
            - 'null'
        status:
          type: string
          enum:
            - pending_upload
            - downloading
            - processing
            - ready
            - error
        readyToStream:
          type: boolean
        durationSeconds:
          type:
            - number
            - 'null'
        sizeBytes:
          type:
            - integer
            - 'null'
        inputWidth:
          type:
            - integer
            - 'null'
        inputHeight:
          type:
            - integer
            - 'null'
        thumbnailUrl:
          type:
            - string
            - 'null'
        thumbnailTimestampPct:
          type: number
        playbackHlsUrl:
          type:
            - string
            - 'null'
        playbackDashUrl:
          type:
            - string
            - 'null'
        requireSignedUrls:
          type: boolean
        allowedOrigins:
          type: array
          items:
            type: string
        tags:
          type: array
          items:
            type: string
        maxDurationSeconds:
          type:
            - integer
            - 'null'
        maxSizeBytes:
          type:
            - integer
            - 'null'
        watermarkProfileId:
          type:
            - string
            - 'null'
        downloadStatus:
          type: string
          enum:
            - disabled
            - inprogress
            - ready
            - error
        downloadReadyAt:
          type:
            - string
            - 'null'
          format: date-time
        errorCode:
          type:
            - string
            - 'null'
        errorMessage:
          type:
            - string
            - 'null'
        meta:
          type: object
          additionalProperties:
            type: string
        uploadedAt:
          type:
            - string
            - 'null'
          format: date-time
        readyAt:
          type:
            - string
            - 'null'
          format: date-time
        lastEventAt:
          type:
            - string
            - 'null'
          format: date-time
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    Error:
      type: object
      properties:
        error:
          type: string
    RateLimitError:
      type: object
      required:
        - error
      properties:
        error:
          type: string
        retryAfterMs:
          type: integer
          description: Milliseconds to wait before retrying.
  responses:
    BadRequest:
      description: Invalid request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Authentication is missing, invalid, revoked, or expired.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: The API token does not include a scope required for this operation.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    TooManyRequests:
      description: Rate limit exceeded.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RateLimitError'
    ServerError:
      description: An unexpected error occurred.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    ServiceUnavailable:
      description: >-
        A required dependency (for example the platform database) is not
        available.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Voyant Cloud API token, passed as `Authorization: Bearer <token>`. Each
        token carries a fixed set of scopes; an operation rejects tokens missing
        its required scope.

````