SendFolderLink

Generates a folderlink and sends the emails.
Emails are send to:
- The sender to confirm that the folderlink was created
- Reciever, the folderlink email
- If notify is turned on, the owner is notified by email if the folderlink is accessed

To access a folderlink, the requestaccess api call can be used with the ID that can be found in the email.

Authentication Methods


  1. With a username and password
  2. Using Kerberos
Input Parameter Type Description
Token* String Security token
FileServerName* String FileServer name
Path* String File or Foldername to remove
Access AccessType Possible access types: ReadWrite, ReadOnly
ShowSubDirs Boolean
ExpiryDays Int Number of days after which filelink expires. Note -1 denotes unlimited
Notify Boolean Whether or not the owner should receive a notification email when the filelink has been accessed
Emails* String[] Array of email addresses that should receive the filelink
Message String Contents of the filelink email
ExpiryDownloads Int Amount of downloads after which to expire. Note -1 denotes unlimited
Password String Password to protect FileLink access
Output Parameter Type Description
Success Boolean Returns true if the filelink was send

*=required

CURL EXAMPLE
curl -v 'https://secure.nomadesk.com/ctrller/api.php?Token=rrc1d3ntb53tt6b2vhail6rdtrsxov3v&Task=SendFolderLink&Access=ReadOnly&FileserverName=nmsa000001&Path=%2Ffile.txt&ExpiryDays=5&Notify=true&Emails=folderlink@nomadesk.com&Message=messagetext'
RESPONSE
<Response>
    <Status>1</Status>
    <Message></Message>
</Response>