put
https://api.assembly.com/v1/files//permissions/
Control client access to files and folders by setting permissions at the folder level or root level of a file channel.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
How Permissions Work
Folder permissions control what actions clients can perform on files:
- read_write: Clients can view, create, and delete files
- read_only: Clients can only view files; they cannot create or delete files
Permission Inheritance
Permissions are inherited hierarchically:
- New folders: When created, folders inherit permissions from their parent folder (or root if created at the top level)
- Files: Files inherit permissions from their parent folder.
- No cascades: Modifying a folder's client permissions via the API only modifies permissions on the folder in the query, not any of it's children. Each folder's permissions must be modified individually.
Update Folder Permissions
Updates the client permissions for a specific folder.
Endpoint
PUT https://api.assembly.com/v1/files/{id}/permissions
Example Request
curl --request PUT \
--url https://api.assembly.com/v1/files/abc123-folder-id/permissions \
--header 'Content-Type: application/json' \
--header 'x-api-key: YOUR_API_KEY' \
--data '{
"clientPermissions": "read_only"
}'Update Root Folder Permissions
Updates the client permissions for the root level of a file channel. The root level contains folder and files that are not inside any folder.
Endpoint
PUT https://api.assembly.com/v1/files/root/permissions
Example Request
curl --request PUT \
--url https://api.assembly.com/v1/files/root/permissions \
--header 'Content-Type: application/json' \
--header 'x-api-key: YOUR_API_KEY' \
--data '{
"channelId": "xyz789-channel-id",
"clientPermissions": "read_only"
}' 200Success
400Bad Request
401Unauthorized
403Forbidden
404Not Found

