Skip to main content

Create folder

POST https://api.rollstack.com/public/v1/folders

Creates a folder owned by the user: at the top level, which only owners and admins of the organization may, or inside a folder the user owns or has manage on. Then file reports in it with updateReport's folderId, or create them there with createReport. Each call creates another folder, even with the same name.

Requires the slide_decks:write scope.

Operation ID: 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, required): 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 create it in, by its id from listFolders: one you own or have manage on. Omit it or pass null to create it at the top level, which only owners and admins of the organization may. Example: a3d5e7f9-1b2c-4d6e-8f0a-1b2c3d4e5f6a.

Response 201

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.
  • permission (string or null, required): What you can do in the folder: view, edit or manage, as in listFolders. manage when you own it. null when you see it only because a report in it is shared with you. One of view, edit, manage.
  • access (array of object, required): Everyone with access to the folder, the owner first.
    • userId (number, required): The member's user id, the same as their id in listMembers.
    • name (string, required): The member's name, as shown in Rollstack.
    • email (string, required): The member's email address.
    • permission (string, required): What they can do in the folder. The owner has manage. One of view, edit, manage.
    • source (string, required): owner for the member who owns the folder, direct when it is shared with them, folder when they reach it through a folder it is nested in, which unshareFolder on this folder leaves as it is. One of owner, direct, folder.
    • folder (string): With folder: the name of the parent folder they reach it through, when you can see that folder.