PUT restapi/personal/elements/folders/{folderId}/v1

Update a folder.

Request Information

URI Parameters

Name	Description	Type	Additional information
folderId	The folder identifier to update	integer	Required

Body Parameters

The folder to update

Itslearning.RestApi.Entities.Folder.FolderRequest

Name	Description	Type	Additional information
ParentFolderId	The parent folder identifier.	integer	None.
Title	The folder title	string	None.
Description	The folder description	string	None.
Visibility	Indicates the activity setting for the folder .	string	None.
VisibleFrom	When the folder is visible from	date	None.
VisibleTo	When the folder is visible to	date	None.
Deadline	The folder deadline. After this date the folder is no longer editable	date	None.
AvailableTools	The list of available tools for the folder	Collection of string	None.
AssignTo	Who the folder is assigned to. If null or empty all participants are assigned	Itslearning.RestApi.Entities.Folder.AssignToModel	None.
ReplaceVisibilityInSubElements	Will replace this folder visibility settings in all sub elements.	boolean	None.
PlanId	If present. The created element should be added to the plan with this id	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "ParentFolderId": 1,
  "Title": "sample string 2",
  "Description": "sample string 3",
  "Visibility": "sample string 4",
  "VisibleFrom": "2026-05-13T09:26:05Z",
  "VisibleTo": "2026-05-13T09:26:05Z",
  "Deadline": "2026-05-13T09:26:05Z",
  "AvailableTools": [
    "sample string 1",
    "sample string 2"
  ],
  "AssignTo": {
    "ParticipantIds": [
      1,
      2
    ],
    "GroupIds": [
      1,
      2
    ]
  },
  "ReplaceVisibilityInSubElements": true,
  "PlanId": 1
}

application/xml, text/xml

Sample:

<FolderRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <AssignTo>
    <GroupIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </GroupIds>
    <ParticipantIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </ParticipantIds>
  </AssignTo>
  <AvailableTools xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </AvailableTools>
  <Deadline>2026-05-13T09:26:05Z</Deadline>
  <Description>sample string 3</Description>
  <ParentFolderId>1</ParentFolderId>
  <PlanId>1</PlanId>
  <ReplaceVisibilityInSubElements>true</ReplaceVisibilityInSubElements>
  <Title>sample string 2</Title>
  <Visibility>sample string 4</Visibility>
  <VisibleFrom>2026-05-13T09:26:05Z</VisibleFrom>
  <VisibleTo>2026-05-13T09:26:05Z</VisibleTo>
</FolderRequest>

application/x-www-form-urlencoded

Sample:

No sample available

Response Information

Resource Description

FolderResponse containing the new folder data

Itslearning.RestApi.Entities.Folder.FolderResponse

Name	Description	Type	Additional information
FolderId	The folder identifier. Same as elementId	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "FolderId": 1
}

application/xml, text/xml

Sample:

<FolderResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <FolderId>1</FolderId>
</FolderResponse>