SHshareout
Folders

Update a Team Space folder

Changed on

Also accepts PUT. Owners/admins for any folder; a member only for folders they created, while members_can_create_folders is on (otherwise 403 ADMIN_REQUIRED).

patch/v1/workspaces/{workspaceId}/folders/{folderId}

Request

  • Base URL
    https://shareout.site
  • URL
    https://shareout.site/v1/workspaces/{workspaceId}/folders/{folderId}
  • Auth
    HTTP bearer

Request body

namestring
slugstring
descriptionstring nullable
readmestring
visibility'inherit' | 'public' | 'workspace' | 'private'

Response

Updated folder

idstring
namestring
slugstring
descriptionstring nullable
artifact_countinteger
parent_idstring nullable

Team Space folders only.

visibility'inherit' | 'public' | 'workspace' | 'private'

Team Space folders only.

subfolder_countinteger

Team Space folders only.

pathstring

Slug path; single-folder Team Space responses only.

readmestring nullable

Single-folder Team Space responses only.

effective_visibilitystring

Single-folder Team Space responses only.

created_atstring date-time

Changes