sharefolder

Name

sharefolder

Auth

yes

Description

Shares a folder with another user.

Share may be subject to confirmation from the other user. The folder to be shared is identified by folderid or path.

Optional share name can be provided, if it is not, the folder name is used as sharename. Implementations are advised to give opportunity to the sharing user to select the share name, which should be pre-filled with the folder name.

The required parameter mail holds the email address of the user with whom you are sharing the folder.

The required parameter permissions sets the permissions for the folder.

Zero for read-only or any combination (sum/or) of

Flag	Description
1	Create permission
2	Modify permission
4	Delete permission

Optional parameter message allows adding a message to pass to the receiving user.

Folder sharing is a complicated operation and the following errors are likely to be returned:

Code	Description
2014	the user's address is not verified. Implementations are advised upon user confirmation to call sendverificationemail and to ask the user to check his/her email.
2015	root folder cannot be shared, this check SHOULD also be performed on the client.
2016	one can only share folders with ismine set to true, implementations SHOULD check this locally too.
2017	user does not accept requests from you or from anybody, implementations can not know if this is going to happen, but are expected to act appropriately on this error.

URL

https://api.pcloud.com/sharefolder

Required

Parameter	Description
folderid	int folder id of the shared folder
path	string path to the shared folder
mail	string mail of the user with whom you are sharing the folder
permissions	int bitwise combination of permission flags

Use path or folderid

Optional

Parameter	Description
name	string name of the share. Default - the folder name.
message	string message to pass to the receiving user.

Example

{
    result: 0
}

Errors