Skip to navigation
Gateway APIFolders

Confirm a folder share with its code

View as Markdown

Apply a share that you asked for with share_folder. Give the 6-digit code that Basement emailed to the person who connected you. Only that person has the code: ask them for it and do not guess. 5 wrong codes cancel the request. A code works one time. Requires write access.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
shareIdstringRequired

The shareId that share_folder returned

codestringRequired

The 6-digit code from the person's email

Response

The tool's answer.
oktrue
folderIdstring
folderNamestring
levelenum
Allowed values:
sharedWithstring

Who got access: "all members of the organization" or "2 members"

Errors

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