Skip to navigation
Gateway APIFolders

Ask to share a folder

View as Markdown

Ask to share a folder with all members of the organization, or with some members by email. This call shares nothing. Basement emails a 6-digit code to the person who connected you. Ask that person for the code, then call confirm_folder_share. The person must be the owner of the folder, or an owner or admin of the organization. A request is valid for 15 minutes; you can make 5 requests in one hour. Requires write access.

Authentication

AuthorizationBearer

A Basement key (bsmt_...), from Agents, Connect in the app.

Request

This endpoint expects an object.
folderIdstringRequired

The folder ID from list_folders

levelenumRequired

view: read the files. edit: also add and change files. A viewer of the organization never edits

Allowed values:
withOrganizationbooleanOptional
true to share with all members of the organization. Do not give emails
emailslist of stringsOptional
The emails of the members to share with. Each one must be a member of the organization. Do not give withOrganization

Response

The tool's answer.
shareIdstring

Give it to confirm_folder_share with the code

confirmation"code_sent"
sentTostring
The email that got the code, with its name part hidden
expiresInMinutesinteger
messagestring
What to do next

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
429
Too Many Requests Error
500
Internal Server Error