PUT Update Video Metadata

Syntax

The following method is used to update an existing video object in the system using PUT.

Note: This method updates an existing video object by passing a valid video JSON object in the PUT body raw data.

Note: Currently the only mandatory parameter and value that are required for updating a Video object in the system is a video 'id'.

URL

Note: The parameter highlighted in red is a placeholder for the mandatory value described bellow.

http://api.vidible.tv/COMPANY_KEY/video
  • COMPANY_KEY - Replace this placeholder with your Company Key.
    Note: If you do not have a Company Key, please contact our support team and provide your company's name and details.


JSON Payload

  • JSON Video Object - Pass a valid JSON Video Object via the method's 'Body' 'Raw' data. For further details on how to structure the Video JSON Object, please see Video JSON object specification.

    Important! It is mandatory to pass the Video ID in the JSON object to identify the video you wish to update.

    Important! 'Content-type' parameter header must be set with a value of 'application/json'.

 

 

 

Try it out by clicking here.

 

Examples

 

Basic Update Video Request

Description: This method is used to update a video object.

Method: PUT

URL:

http://api.vidible.tv/5d3f3b3ac9374m3463be2557e04697ad/video


JSON Object

Note: The following JSON Object is sent via the 'Body' 'Raw' data with a Header 'Content-type' parameter set to 'application/json'.

Important! It is mandatory to pass the Video ID in the update JSON object to identify the video you wish to update.

{"id":"56d2f296e4b0286b7d0d30dc","name":"Updated Playlist Name"}

 

Response

{
"id": "56d2f296e4b0286b7d0d30dc",
"companyId": "56caee32e4b013d45a4273eb",
"creationDate": 1456665238403,
"modificationDate": 1456665238403,
"name": "Updated Name",
"metadata": {

},
"encodedVariants": [],
"thumbnailsNew": [],
"commonRating": {
"value": "G",
"descriptors": [],
"minAge": 0
},
"audienceGender": "All",
"countries": [],
"media": {

},
"contentLifecycle": "Evergreen",
"associatedCompanies": [],
"logo": {
"region": {
"x": 0,
"y": 0,
"w": 0,
"h": 0
}
},
"sellerRuleId": "56caee32e4b099244a14355a",
"deleted": false,
"supportedPlayerTypes": [],
"playbackAvailable": false,
"ageRatings": ["NONE_SPECIFIED"],
"external": true,
"version": 2
}

 

 

 

Advanced Update Video Request

Description: This method is used to update a video object.

Method: PUT

URL:

http://api.vidible.tv/5d3f3b3ac9374m3463be2557e04697ad/video

 

JSON Object

Note: The following JSON Object above is sent via the 'Body' 'Raw' data with a Header 'Content-type' parameter set to 'application/json'.

Important! It is mandatory to pass the Video ID in the update JSON object to identify the video you wish to update.

{
"id": "56d2f296e4b0286b7d0d30dc",
"description": "Correspondent Craig Boswell reports.",
"category": ["US News"],
"keywords": ["cbs 2 philly",
"philadelphia news",
"eyewitness news weekends"],
"commonRating": {
"value": "G",
"descriptors": [],
"minAge": 0
},
"credit": "CBS News 3",
"audienceGender": "All",
"author": ["Daily News"],
"clickUrl": "http://www.cbsnews.com/",
"ageRatings": ["SENIORS",
"TEENS",
"ADULTS"]
}

 

Response

{
"id": "56d2f296e4b0286b7d0d30dc",
"companyId": "56caee32e4b013d45a4273eb",
"creationDate": 1456665238403,
"modificationDate": 1456747432983,
"name": "Updated Namme",
"description": "Correspondent Craig Boswell reports.",
"metadata": {

},
"category": ["US News"],
"keywords": ["cbs 2 philly",
"philadelphia news",
"eyewitness news weekends"],
"encodedVariants": [],
"thumbnailsNew": [],
"commonRating": {
"value": "G",
"descriptors": [],
"minAge": 0
},
"credit": "CBS News 3",
"audienceGender": "All",
"countries": [],
"media": {

},
"contentLifecycle": "Evergreen",
"associatedCompanies": [],
"author": ["Daily News"],
"clickUrl": "http://www.cbsnews.com/",
"logo": {
"region": {
"x": 0,
"y": 0,
"w": 0,
"h": 0
}
},
"sellerRuleId": "56caee32e4b099244a14355a",
"deleted": false,
"supportedPlayerTypes": [],
"playbackAvailable": false,
"ageRatings": ["TEENS",
"SENIORS",
"ADULTS"],
"external": true,
"version": 3
}

 

 

Have more questions? Submit a request