Create Share for Send
Create a secure share link to send files, folders, and more resources to designated recipients. It includes options for access permissions, expiration, and notifications.
Input
| Field | Definition | Type | Required |
|---|---|---|---|
|
Share |
|||
|
Items |
Specifies the files or folders included in the share by unique IDs. |
List of Text | TRUE |
|
Title |
The title of the shared content. |
Text | FALSE |
|
Require Login |
If true, recipients must log in to access the share. |
True/False | FALSE |
|
Require User Info |
If true, recipient details are required to access the share. |
True/False | FALSE |
|
Expiration Date |
The date when the share link expires. If not specified, it defaults to 30 days. Enter a value of 9999-12-31 if you don't want it to expire. |
Date & Time | FALSE |
|
Max Downloads |
Maximum number of downloads per user. Enter a value of -1 to set to unlimited. Enter a value of 0 to restrict access. |
Number | FALSE |
|
Uses Stream IDs |
If true, items are identified by stream IDs rather than item IDs. |
True/False | FALSE |
|
Recipients |
List of users to request files from, identified by User ID or Email. |
List of Text | FALSE |
|
Notify Recipients |
If true, an email notification is sent when recipients download a file. |
True/False | FALSE |
Output
| Field | Definition | Type |
|---|---|---|
|
Share |
||
|
Alias ID |
The unique identifier per recipient for tracking activity. This is the same as the Share ID for anonymous shares. |
Text |
|
ID |
The unique identifier for the share. |
Text |
|
Share Type |
The type of share (Send or Request). |
Text |
|
Title |
The title of the share. |
Text |
|
Has Sent Message |
Indicates if Citrix ShareFile has sent an email for this share. |
True/False |
|
Sent Message Title |
The subject line of the share email. |
Text |
|
Require Login |
If true, only logged-in users can access the share. |
True/False |
|
Require User Info |
If true, recipients must enter their details before they can access the files. |
True/False |
|
Share Access Level |
Specifies the level of access granted to the share (RequireUserInfo, RequireLogin, or Anonymous). |
Text |
|
Creation Date |
The date the share was created. |
Date & Time |
|
Expiration Date |
The date when the share expires. |
Date & Time |
|
Max Downloads |
The maximum number of downloads allowed per user. A value of -1 indicates unlimited. |
Number |
|
Total Downloads |
The total number of downloads across users. |
Number |
|
Is View Only |
If true, files can be viewed but not downloaded. |
True/False |
|
Track Until Date |
The date until user activity on the share is tracked. |
Date & Time |
|
Send Frequency |
The frequency of reminder emails. A value of -1 disables reminders. |
Number |
|
Send Interval |
The number of days between reminders. A value of -1 disables scheduling. |
Number |
|
Last Date Sent |
The date the last email was sent for the share. |
Date & Time |
|
Is Consumed |
Indicates if the share has been downloaded. |
True/False |
|
Is Read |
Indicates if an authenticated recipient opened the share. |
True/False |
|
Is Archived |
Indicates if the share link has been archived. |
True/False |
|
Send Tool |
The app or integration used to send the share. |
Text |
|
Send Method |
The method used to deliver the share such as email or GetLink. |
Text |
|
Uses Stream IDs |
Specifies if stream IDs are used instead of item IDs. |
True/False |
|
URI |
The web link to access the share. |
Text |
|
Signature |
A unique digital signature used to validate share integrity. |
Text |
|
Share Sub Type |
The specific subtype of the share, if applicable. |
Text |
|
Access Right Type |
Type of access granted such as FullControl or ReadOnly. |
Text |
|
Display Text |
Describes the permissions granted to recipients. |
Text |
|
Access Right Type |
Type of access granted such as FullControl or ReadOnly. |
Text |
|
Is Watermarked |
Indicates if watermarks are applied to shared content. |
True/False |
|
Is View Only |
If true, content can only be viewed, not downloaded or edited. |
True/False |
|
Is Editable |
If true, recipients are allowed to edit shared content. |
True/False |
|
Requires Login |
If true, recipients are required to log in to access the share. |
True/False |
|
Requires Stream IDs |
If true, stream IDs are used instead of item IDs. |
True/False |
|
ID |
The unique identifier for the specific share access right. |
Text |
|
Is Persistent Link |
Indicates if the share is a persistent link (Send only). |
True/False |
|
URL |
Direct-access link to the share. |
Text |