Folder

Update Folder

Update Folder.

patch/api/v3/folder/{folder_id}

Request

  • Base URL
    https://{tenant_name}.benchling.com
  • Auth
    HTTP bearer

Path parameters

folder_idstring required

ID of the Folder.

Request body

archiveReasonstring

Why it is being archived. Required when archived is true, and not allowed when unarchiving.

archivedboolean

Set to true to archive or false to unarchive it. Archiving requires archiveReason.

descriptionstring nullable
namestring

Response

OK

__typenamestring
archiveReasonstring nullable
archivedboolean
childrenstring uri

The folders directly nested under this folder.

createdAtstring datetime
descriptionstring nullable
idstring
modifiedAtstring datetime nullable
namestring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.