POST/api/v1/workspaces/{workspace_id}/folders/{folder_id}/access/share

Share a folder with people or teams

Gives people (by email) and teams access to everything in the folder that isn't private, now and later. Each person newly given access gets one email and one notification for the whole folder, never one per item.

API token required30 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

  • emailsarray of string

    Up to 50 items.

  • team_idsarray of string

    Team ids, slugs or names. Up to 20 items.

  • role"viewer" | "editor"

    Default "viewer".

  • notifyboolean

    Default true.

  • messagestring

    Up to 500 characters.

  • restrictboolean

    Also restrict the folder to its people and teams (true), or lift the restriction (false). Absent: unchanged.

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?