Edit a Video’s Access Control

This endpoint is used to edit the Access Control permissions on a specific video.

PUT

/api/v2/videos/{videoId}/access-control

Usage Notes | Change Log

This endpoint allows Access Control entities to be set for all four types of access control. Note that if set to Public, the Public setting must first be enabled on the Rev account and a password may then also be set if desired. If set to Channels, there should be one valid Channel in the account, otherwise the request will be rejected. The default setting is Private.

Path Parameters

Parameter	Type	Validations
videoId	string, required	ID of video to edit.

Example

application/json

{ "AccessControlEntities": [ { "canEdit": true, "id": "6bfb1ad1-71d3-4d9a-9915-d2087865529d", "type": "Group" }, { "canEdit": true, "id": "82d107af-2ec7-49c3-aea2-d35d0c35784h", "type": "User" }, { "canEdit": true, "id": "29ax1ad1-71d3-4d9a-9915-d2087865426s", "type": "Channel" } ] }

Schema

Parameter	Type	Validations
AccessControlEntities	array[uploadAccessControlEntity], required	Provides explicit rights to a video to a User / Group / Channel. The array further specifies if they can edit the video through the use of the canEdit parameter. The array contains the following properties: id = GUID of the access control entity OR name = used only if the id of the access control entity is not known type = user / group / channel to be provided permissions to the entity canEdit = true / false, specifies whether or not the entity is granted edit abilities (Include either id OR name, both are not required when submitting a user, group or channel)
AcessControl	string, optional	Type of access control to be updated; Private, Public, AllUsers, or Channels. Private is the default. If you specify Channel, at least one valid Channel must be present in Rev or the request will be rejected.
Password	string, optional	Only used if videos with a Public Access Control are set. You can set a password for these videos if desired.

Parameter

Type

Validations

AccessControlEntities

array[uploadAccessControlEntity], required

Provides explicit rights to a video to a User / Group / Channel. The array further specifies if they can edit the video through the use of the canEdit parameter. The array contains the following properties:

id = GUID of the access control entity OR
name = used only if the id of the access control entity is not known
type = user / group / channel to be provided permissions to the entity
canEdit = true / false, specifies whether or not the entity is granted edit abilities
(Include either id OR name, both are not required when submitting a user, group or channel)

AcessControl

string, optional

Type of access control to be updated; Private, Public, AllUsers, or Channels. Private is the default. If you specify Channel, at least one valid Channel must be present in Rev or the request will be rejected.

Password

string, optional

Only used if videos with a Public Access Control are set. You can set a password for these videos if desired.

search check