Skip to main content
POST
cURL
Creates a folder in a space. The creatorEmail must belong to an active workspace member who is not a guest, and who gets full access to the folder.

Authorizations

X-Claap-Key
string
header
required

Body

application/json
creatorEmail
string<email>
required

Email of the workspace member recorded as the folder creator, who gets full access to it.

memberPermission
enum<string>
required

Permission of workspace members on the folder. FullAccess makes it a shared folder; NoAccess makes it private to the creator and the users they invite.

Available options:
NoAccess,
CanView,
CanComment,
FullAccess
spaceId
string
required

Identifier of the space (sidebar group of folders) the folder belongs to, as the spaceId of an existing folder.

title
string
required

Folder title.

Minimum string length: 1
description
string

Folder description, in markdown.

iconId
string

Emoji shortcode used as the folder icon, for example :file_folder:.

publicPermission
enum<string>
default:NoAccess

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
searchable
boolean
default:true

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

Response

Folder was successfully created

result
object
required