PUT/api/v1/workspaces/{workspace_id}/folders/{folder_id}/access

Set who can access a folder

Restrict a folder to its people and teams, replace its own people / teams, and set what new items start as (folder = its people and teams). Everything inside, including subfolders and items added later, follows at once. Workspace admins, the folder's creator and its editors.

API token required60 per minute per IP

Guide: Folder access

Code samples and Try it

Path parameters

#
  • workspace_idstringRequired

    The workspace's id, from the address of its settings page (markdrop.in/settings/workspaces/<workspace-id>) or from List workspaces.

  • folder_idstringRequired

    The folder's id, from List folders.

Request body

#

application/json, required

  • restrictedboolean

    Only the folder's people and teams (and item owners, people an item is shared with, workspace admins) open what's inside.

  • peoplearray of object

    Up to 200 items.

    2 fields inside
    • emailstringRequired

      3–254 characters.

    • role"viewer" | "editor"

      Default "viewer".

  • teamsarray of object

    Up to 50 items.

    2 fields inside
    • team_idstringRequired

      The team's id, slug or name. 1–80 characters.

    • role"viewer" | "editor"

      Default "editor".

  • default_access"private" | "folder" | "workspace" | "link"

    What new items here start as; send null to clear (the workspace's default).

  • notifyboolean

    Tell people newly given access (one email / notification each). Default false.

  • messagestring

    Up to 500 characters.

Responses

#
  • 200OK.
  • 401No token, or the token is revoked or mistyped.
  • 422The request didn't validate. detail lists each problem, with where it is (loc) and why (msg).
  • 429Too many requests from your IP address. Wait the seconds in Retry-After.
Did this page help?