Uiza Documentation
2020-04-21
2020-04-21
  • Hola! 👋
  • Getting Started
    • Introduction
    • Authentication
    • Errors
    • Quick Starts
      • Live Streaming
      • Video Streaming
    • Pagination
    • Recommended Specifications
    • Postman Collections
    • Sample Streaming Apps
      • NodeJS Live Streaming App
      • Java Live Streaming App
      • Python Live Streaming App
      • How to integrate live streaming into an Android App using Uiza’s Live API
    • Versioning
  • API Reference
    • Live Entities
      • Create A Live Entity
      • Retrieve A Live Entity
      • Update A Live Entity
      • Delete A Live Entity
      • List All Live Entities
      • Enable Live Entity DVR
      • Disable Live Entity DVR
      • Reset Ingest Key
    • Live Sessions
      • Retrieve A Live Session
      • List All Live Sessions
    • Video Entities
      • Retrieve A Video Entity
      • Update A Video Entity
      • Publish A Video Entity
      • Delete A Video Entity
      • List All Video Entities
    • Video Presets
      • Create a Video Preset
      • Retrieve a Video Preset
      • Update a Video Preset
      • Delete a Video Preset
      • List all Video Presets
      • Add Profile(s) to Video Preset
      • Remove Profile(s) from Video Preset
    • Video Profiles
      • List All Video Profiles
    • Events
      • Retrieve An Event
      • List All Events
      • Event Types
    • Webhook Endpoints
      • Create Webhook Endpoint
      • Retrieve Webhook Endpoint
      • Update Webhook Endpoint
      • Delete Webhook Endpoint
      • List All Webhook Endpoints
      • Enable A Webhook Endpoint
      • Disable A Webhook Endpoint
  • SDK REFERENCE
    • Introduction
    • Android SDK
      • Android Player SDK
      • Android Broadcast SDK
    • iOS SDK
      • iOS Player SDK
      • iOS Broadcast SDK
    • Web Player SDK
  • API UPGRADES
    • Release Notes
    • API Changelog
Powered by GitBook
On this page

Was this helpful?

  1. API Reference
  2. Video Entities

Update A Video Entity

Updates a specified video entity's name, description, poster and thumbnail imaged. Any parameters not provided will be left unchanged.

/v1/video_entities/:id

PUT https://api.uiza/sh/v1/video_entities/:id

Path Parameters

Name
Type
Description

id

string

The identifier of the video entity to be updated.

Request Body

Name
Type
Description

name

string

The new name of the video entity to be updated. This parameter cannot be empty in your body request.

description

string

The new description of the video entity to be updated. This version does not support update description as an empty string. In case your old description is incorrect, replace it with the new one that makes more sense.

short_description

string

The new short description of the video entity to be updated. Same as description, replace it with the new one when your old is incorrect.

poster

string

The URL of the new video entity's poster image to be updated. Same as description, replace it with the new one when your old is incorrect.

thumbnail

string

The URL of the new video entity's thumbnail image to be updated. Same as description, replace it with the new one when your old is incorrect.

{
 "id": "f42b4ac3-869e-4010-8e21-042e40be7655",
 "name": "Sample Demo-Video 1",
 "description": "Habemus nusquam tractatos ut eam, eu brute aliquam fuisset sea",
 "short_description": "Duo ad graeci principes, legimus mnesarchum scribentur ut pro",
 "view": 1000,
 "poster": "Lorem ipsum dolor",
 "thumbnail": "Lorem ipsum dolor",
 "input_type": "VOD",
 "duration": 11213,
 "publish_to_cdn": "queue",
 "created_at": "2019-12-11T02:47:04Z",
 "updated_at": "2019-12-11T02:47:04Z"
}
{
 "message": "Your request is missing id parameter. Please, verify and resubmit.",
 "error_type": "invalid_request_error"
}
{
 "message": "You are unauthorized to access the requested resource. Please verify and resubmit.",
 "error_type": "invalid_request_error"
}
{
 "message": "The video entity you requested does not exist.",
 "error_type": "invalid_request_error"
}
{
 "message": "An unexpected error occurred on Uiza's end.",
 "error_type": "api_error"
}
Sample Request
curl -X PUT https://api.uiza.sh/v1/video_entities/f42b4ac3-869e-4010-8e21-042e40be7655 
     -H 'Authorization: uap-c1ffbff4db954ddcb050c6af0b43ba56-41193b64' 
     -d '{"name":"Sample Demo-Video 1", "description":"Habemus nusquam tractatos ut eam, eu brute aliquam fuisset sea"}'
PreviousRetrieve A Video EntityNextPublish A Video Entity

Last updated 5 years ago

Was this helpful?