Skip to main content

Update folder

PATCH https://api.rollstack.com/public/v1/folders/{id}

Renames a folder, or moves it into another folder or to the top level, with everything in it. Members of the folder it moves into get access to its reports. Needs manage on the folder, or owning it, and the same on the one it moves into. Answers the name and parent of the folder: getFolder gives who has access.

Requires the slide_decks:write scope.

Operation ID: updateFolder.

Path parameters

  • id (string, required): The folder to act on, by its id from listFolders or createFolder.

Headers

  • Idempotency-Key (string): A unique value, such as a UUID, that makes retrying this call safe. A retry with the same key within 24 hours answers the first call's result instead of running it again. Use a new key for each new call. From 1 to 255 printable ASCII characters.

Request body, required

application/json

  • name (string): The folder's name, as members will see it in Rollstack. Leading and trailing spaces are removed, and it can't be blank. Example: Q3 business reviews.
  • parentFolderId (string or null): The folder to move it into, by its id from listFolders, one you own or have manage on, and not the folder itself or one nested in it. Pass null to move it to the top level. Its reports, bursts and subfolders move with it. Example: a3d5e7f9-1b2c-4d6e-8f0a-1b2c3d4e5f6a.

Response 200

Success

application/json

  • id (string, required): Unique identifier for the folder.
  • name (string, required): The folder's name, as shown in Rollstack.
  • parentFolderId (string or null, required): The folder this one is nested in. null for a folder at the top level.