Edit Video Metadata
This endpoint is used to set or modify metadata fields for a specific video. You do not need to provide the metadata fields that you are not changing for the video.
Path Parameters
| Parameter | Type | Validations |
|---|---|---|
| videoId | string, required | ID of video to edit. |
Request Body
application/json
{
"id": "string",
"title": "string",
"description": "string",
"thumbnailUrl": "string",
"linkedUrl": "string",
"categories": [
"string"
],
"tags": [
"string"
],
"isActive": true,
"approvalStatus": "string",
"enableRatings": true,
"enableDownloads": true,
"enableComments": true,
"videoAccessControl": "string",
"canEdit": true,
"accessControlEntities": [
{
"id": "string",
"name": "string",
"type": "string",
"canEdit": true
}
],
"customFields": [
{
"id": "string",
"name": "string",
"value": "string",
"required": true,
"displayedToUsers": true,
"fieldType": "string"
}
],
"expirationDate": "2017-08-31",
"expirationAction": "delete",
"uploadedBy": "string",
"whenUploaded": "string",
"publishDate": "2019-08-06",
"unlisted": true,
"userTags": [
"e3031353-df6e-4c2f-9884-af79dcfe87bd",
"5d8ebc19-fad7-40fc-9682-bbd6a56a89b4",
"6d5249cb-5ce2-4ec0-97fb-e7362ca75fd5"
]
}
| Parameter | Type | Validations |
|---|---|---|
| id | string, optional | The video id |
| title | string, optional | The video title |
| description | string, optional | The video description |
| thumbnailUrl | string, optional | The URL to the video’s thumbnail image |
| linkedUrl[] | array[uploadlinkedUrl], optional |
The linked URL array can contain the following properties:
|
| categories[] | array[uploadcategoryids], optional |
Assign the video to multiple category GUIDs if desired. If you use categoryIds and they do not exist/are incorrect, the request will be rejected. The request is also rejected if you do not have contribute rights to a restricted category and you attempt to add/edit or otherwise modify it. |
| tags[] | array[uploadtagids], optional | Assign the video to multiple tag GUIDs if desired. |
| isActive | boolean, optional | The video status; false by default. |
| approvalStatus | string, optional | Must match defined status in Rev. |
| enableRatings | boolean, optional | Allows video to be rated; true by default. |
| enableDownloads | boolean, optional | Allows video to be downloaded; true by default. |
| enableComments | boolean, optional | Allows comments on the video; true by default. |
| videoAccessControl | string, optional |
The video access control options include:
Note: If Channels is set as a videoAccessControl, then a Channel must be specified in the the accessControlEntities parameter below. If a Channel is included in the accessControlEntities, then the canEdit option will be ignored. |
| password | string, optional | May be used if the videoAccessControl is set to Public. |
| canEdit | string, optional | Used in the accessControlEntities parameter below to specify if the Access Control has permissions to edit the video. |
| accessControlEntities[] | array[uploadAccessControlEntity], optional |
The video access control may contain the following properties:
Note: If Channels is set as a videoAccessControl, then a Channel must be specified in the the accessControlEntities parameter. If a Channel is included in the accessControlEntities, then the canEdit parameter will be ignored. |
| customFields[] | array[uploadCustomFields], optional |
If a custom field is set as required in Rev, then the custom field is required in the upload/edit API calls. (See the custom fields endpoints to retrieve custom fields). Options in the customFields array include:
|
| expirationDate | string, optional | Date field to prompt expirationAction. Format must be: YYYY-MM-DD |
| expirationAction | string, optional | This field specifies what to do with the video upon expiration; set to inactive status or delete. Values are delete or inactive. |
| uploadedBy | string, optional | Changes the video uploader (user). Mostly used for migration purposes. |
| whenUploaded | string, optional | Changes the video uploaded date. Mostly used for migration purposes. |
| publishDate | date, optional |
By default, the publishDate is set to the current date the video is set to Active. You can also set the publishDate to a date in the future to make the video Active. If the video is already Active, the publishDate can be set to a date in the past. Note: Format must be YYYY-MM-DD to avoid generating an error. |
| unlisted | boolean, optional | Specifies if the video is unlisted. If unlisted, it is not visible or searchable in the Rev UI by other users. |
| userTags | array [uploadUserIds], optional | An array of user account IDs that are tagged in the video in support of Rev IQ – Facial Recognition. The account must be licensed and enabled for Facial Recognition. If the user does not exist, a 500 error will be returned. |