Update Folder [Auth Required]

Update a folder's name and/or description.

Authorization: Users with folder's org_user_role_id OR org_admin_role_id OR CFIA admin Restrictions: Cannot update default folders for active users

Request: name: Optional new folder name (just the name, not the full path) description: Optional new description

Response: id: UUID of the updated folder message: Success message

Raises: 400: If no fields provided or name conflicts with existing folder 403: If user lacks permission or folder is a default folder 404: If folder not found

put/folders/{folder_id}

Request

  • The document declares no server URL.
  • Auth: none declared

Path parameters

folder_idstring required

Request body

namestring nullable
descriptionstring nullable

Response

Successful Response

idstring required
messagestring required

Changes

No recorded changes to this operation across all 4 revisions of this API.