Update a library status/Transfer a library

Update a library. The following actions can be combined:

  • status: set the library to normal or read-only.
  • name: rename the library.
  • owner: transfer the library to another user. The new owner's role must allow creating libraries. Share links and upload links are transferred to the new owner.
  • reshare (new in v13): true keeps the existing user/group shares when transferring; otherwise they are not carried over.

Permission: System admin (is_staff) whose admin role grants can_manage_library. Admin roles with a restricted permission set (e.g. audit_admin, system_admin) receive 403.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$

The unique identifier of a library

Body Params
string
enum

New library status.

Allowed:
string

New library name.

string

ID/email of the new owner.

string
enum
Defaults to false

Only with owner: true keeps existing shares.

Allowed:
Responses

400

status invalid., name invalid., owner invalid. or the library already belongs to the new owner.

403

Permission denied: the account is not a system admin, or its admin role lacks the required admin permission. Also returned if the new owner's role cannot add libraries, or (multi-tenancy) for organization libraries/users.

404

Library or new owner not found.

500

Internal server error.

Language
Credentials
Bearer
Account-Token
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json