Sharing tools (sharing)

Ask for a file or folder to be shared. Every request waits for an approver, and no link is handed back to the app. An app has these only if an administrator agreed sharing for it and you agreed it when connecting.

create_inbox

Changes thingsScope: sharing

Ask to turn a folder into an email inbox: mail sent to its address is saved into the folder as files. Nothing is set up yet: the request goes to an approver, and the address works only once it is approved.

Argument	Type	Required	What it is
share	string	Yes	The share’s name or id, from list_shares
path	string	Yes	Path of the folder inside the share
address	string	No	The part before the ”@” you would like, optional (made URL-safe; a number is added if it is taken)

request_public_link

Changes thingsScope: sharing

Ask for a public link to a file or folder: anyone with the URL could open it. Nothing is shared yet: the request goes to an approver, and no URL is returned. Once approved, the person finds the link in Foldr.

Argument	Type	Required	What it is
share	string	Yes	The share’s name or id, from list_shares
path	string	Yes	Path of the file or folder inside the share
expiry_days	integer	No	Days until the link stops working; 0 for none, -1 to end after the first download (an administrator’s limit may shorten it)
password	string	No	A password the visitor must enter, optional
description	string	No	Text shown on the link’s page, optional

request_secure_link

Changes thingsScope: sharing

Ask to share a file or folder with people OUTSIDE your organisation by email: each would get an email and sign in to view. Nothing is sent yet: the request goes to an approver, and the recipients are emailed only if it is approved.

Argument	Type	Required	What it is
share	string	Yes	The share’s name or id, from list_shares
path	string	Yes	Path of the file or folder inside the share
recipient_emails	string	Yes	One or more email addresses, separated by commas or spaces (at most 20)
expiry_days	integer	No	Days until the link stops working; 0 for none, -1 to end after the first download (an administrator’s limit may shorten it)
description	string	No	Text shown on the link’s page and in the email, optional

share_file

Changes thingsScope: sharing

Ask to share a file or folder with people or groups in your organisation. Nothing is shared yet: the request goes to an approver, and the people get access (and are told) only if it is approved.

Name each person by their email address or username exactly, or a group by its exact name.

Argument	Type	Required	What it is
share	string	Yes	The share’s name or id, from list_shares
path	string	Yes	Path of the file or folder inside the share
people	list of string	Yes	Email addresses or usernames of people, or exact group names, in your organisation (at most 20)
permission	string	No	“read” (default) or “write”
message	string	No	A note shown with the share, optional
expiry_days	integer	No	Days until their access ends; 0 for none (an administrator’s limit may shorten it)