Patch Video Metadata – Vbrick

Page optimized for desktop experience. Please use a desktop browser for best compatibility.

Patch Video MetadataCurtis HarryFebruary 14, 2020April 20, 2021

Home
Change Log
Authentication
- OAuth Login
  - Get Authorization
  - Post Access Token Request
- Post User API Key Login
- Post Extend API Key Session
- Delete Revoke API Key Session
- Post Username Login
- Post Extend Username Session
- Post Username Logoff
User Accounts
- Post Create a User
- Delete Delete a User
- Post Upload a Profile Image
- Delete Delete a Profile Image
- Get List All Roles
- Get User Session
- Patch Patch User Data
User Search
- Get Search Access Entity
- Get Search By UserID
- Get Search By Username
- Get Search By Email
- Get List Users in a Group
Video
- Post Upload a Video
- Post Link a Video
- Get Get Video Details
- Get Get Video Status
- Get Get Playback URL
- Get Download a Video
- Put Edit Video Metadata
- Patch Patch Video Metadata
- Put Migrate a Video
- Put Edit Video Access Control
- Put Replace a Video
- Put Transcode a Video
- Delete Delete a Video
- Video Conference Recording
- Post Supplemental Files & Thumbnails
- Chapters
- Comments & Ratings
- Get Search Video
- Approval Processes
- Post Transcription & Translation
- Post Tag Users
- Get Get Tag Users Status
- Get oEmbed
Channels
- Post Create a Channel
- Put Edit a Channel
- Delete Delete a Channel
- Get List Channels
- Get List a User’s Channels
Webcasts
- Post Create a Webcast
- Put Edit a Webcast
- Put Edit Webcast Access Control
- Put Upload Webcast Branding
- Patch Patch Webcast Data
- Control a Webcast
- Link a Webcast
- Delete Delete a Webcast
- Delete Webcasts (in Bulk)
- Get Bulk Webcast Delete Status
- Get Get Webcast Details
- Post Webcast Files
- Webcast Registration Fields
- Webcast Q&A Management
Zones
- Post Create a Zone
- Put Edit a Zone
- Get List Zones
- Get List Zone Devices
- Delete Delete a Zone
DME Management
Presentation Profiles
Playlists
- Playlist Management
- Put Featured Playlist
Analytics
- Get Video Report
- Get Webcast Reports
- Get User Reports
- Get Rev IQ Credits Usage
Administrative
- Get Account Branding
- Get System Health
- Get Maintenance Schedule
- Category Management
- Group Management
- Custom Fields
Audit
- Get Audit Videos
- Get Audit Users
- Get Audit Groups
- Get Audit Events
- Get Audit Devices
- Get Audit Principal (User)

Patch Video Metadata

Partially edits the metadata details of a video. You do not need to provide the fields that are not changing.

PATCH

/api/v2/videos/{videoId}

Usage Notes | Change Log

Only fields that are able to be modified by the PUT endpoint are allowed to be modified.
This endpoint sets only the attributes/values specified in the request. However, be aware that it does validate the entirety of the attribute list in the same way the Rev UI does. The most notable example is if you attempt to set an attribute (such as title) via the API and there is a required custom field that has not been set. In this case, the API will return an error and not set the value.
Attribute names MUST start with an Uppercase letter. Example: ApprovalStatus NOT approvalStatus.

Request Body

Example

Example

application/jsonpatch

Refer to http://jsonpatch.com/ for the format of the request body.

Patch operations on video non-editable fields [Id,ApprovalStatus,UploadedBy,WhenUploaded,LastViewed] will be ignored.

Operations supported:

add
remove
copy
replace
test
move

Add operation: {"op": "add", "path": "/Categories/0", "value": "03846100-96ac-4628-bbe3-b23a0df1081d"}

Replace operation:{"op": "replace", "path": "/accessControlEntities/0/CanEdit", "value": "false"}

Response Messages

200

Successful response

401

Unauthorized error

409

Conflict error

500

Internal server error