Open app
Folders

Share folder

Shares a folder with people, teams, or workspaces, changes their access, or removes them. People outside the folder's workspace, even without an account, can be added by email. On the workspace folder, only a workspace's access can change. Returns the updated folder.

POST
/folder/{folderId}/share

Path Parameters

folderId*string

The unique identifier of the folder.

Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

The people, teams or workspaces to share with, up to 50. Targets that fail are listed in errors; the rest still apply.

Items1 <= items <= 50
[index: integer]?|||

Response Body

application/json

application/json

application/json

curl -X POST "https://example.com/folder/string/share" \  -H "Content-Type: application/json" \  -d '[    {      "email": "user@example.com"    }  ]'
{  "id": "string",  "name": "string",  "url": "string",  "canManage": true,  "color": "string",  "icon": "string",  "visibility": "Closed",  "workspaceId": 1,  "errors": [    {      "error": "string",      "index": 0    }  ],  "invitations": [    {      "profileId": 1,      "name": "string",      "access": "Owner",      "email": "string"    }  ],  "invitedPeople": [    {      "profileId": 1,      "access": "Owner",      "email": "string",      "isContributor": true    }  ],  "joinRequests": [    {      "profileId": 1,      "name": "string",      "email": "string"    }  ],  "members": [    {      "profileId": 1,      "name": "string",      "access": "Owner",      "email": "string",      "isContributor": true,      "isOwner": true,      "userId": 1,      "teamIds": [        1      ],      "workspaceIds": [        1      ]    }  ],  "ruleGroups": [    {      "conditions": [        {          "operator": "Include",          "type": "Tags",          "value": "string"        }      ]    }  ],  "teams": [    {      "access": "Owner",      "isContributor": true,      "teamId": 1    }  ],  "type": "Default",  "workspaces": [    {      "access": "Owner",      "isContributor": true,      "workspaceId": 1    }  ]}
{  "code": "string",  "error": "string",  "seatsToAdd": 1,  "issues": [    {      "message": "string",      "path": "string"    }  ]}
{  "code": "string",  "error": "string",  "seatsToAdd": 1,  "issues": [    {      "message": "string",      "path": "string"    }  ]}