Skip to main content
PATCH
cURL
The update is partial: omitted attributes keep their current values, and an empty body leaves the folder unchanged. Either all provided attributes are saved or none are. API keys without access to private recordings cannot access folders whose memberPermission is NoAccess: they are reported as not found.

Authorizations

X-Claap-Key
string
header
required

Path Parameters

folderId
string
required

Folder identifier

Body

application/json
description
string

New folder description, in markdown. Pass an empty string to clear it.

iconId
string

New emoji shortcode used as the folder icon.

memberPermission
enum<string>

New permission of workspace members on the folder.

Available options:
NoAccess,
CanView,
CanComment,
FullAccess
Example:

"FullAccess"

publicPermission
enum<string>

New public link of the folder. NoAccess turns it off. CanComment lets anyone with the link open the folder without signing up, and requires public links to be enabled on the workspace.

Available options:
NoAccess,
CanComment
Example:

"NoAccess"

searchable
boolean

Whether workspace members can find the recordings of the folder in search results. Ignored when memberPermission is NoAccess.

title
string

New folder title.

Minimum string length: 1

Response

Folder was successfully updated

result
object
required