Bundle Notifications
A BundleNotification is an E-Mail sent out to users when certain actions are performed on or within a shared set of files and folders.
List Share Link Notifications
Command
files-cli bundle-notifications list
Output
Outputs a list of BundleNotification objects according to the output format.
Authorization Requirement
Available to all authenticated keys or sessions.
Flags
| Flag | Description |
|---|---|
| --user-id= int64 | User ID. Provide a value of 0 to operate the current session's user. |
| --bundle-id= int64 | Bundle ID |
Additional Arguments
Show Share Link Notification
Command
files-cli bundle-notifications find
Output
Outputs a BundleNotification object according to the output format.
Authorization Requirement
Available to all authenticated keys or sessions.
Flags
| Flag | Description |
|---|---|
| --id= int64 Required | Bundle Notification ID. |
Create Share Link Notification
Command
files-cli bundle-notifications create
Output
Outputs a BundleNotification object according to the output format.
Authorization Requirement
Available to all authenticated keys or sessions.
Flags
| Flag | Default | Description |
|---|---|---|
| --user-id= int64 | User ID. Provide a value of 0 to operate the current session's user. | |
| --bundle-id= int64 Required | Bundle ID to notify on | |
| --notify-user-id= int64 | The id of the user to notify. | |
| --notify-on-registration boolean | false | Triggers bundle notification when a registration action occurs for it. |
| --notify-on-upload boolean | false | Triggers bundle notification when a upload action occurs for it. |
Update Share Link Notification
Command
files-cli bundle-notifications update
Output
Outputs a BundleNotification object according to the output format.
Authorization Requirement
Available to all authenticated keys or sessions.
Flags
| Flag | Description |
|---|---|
| --id= int64 Required | Bundle Notification ID. |
| --notify-on-registration boolean | Triggers bundle notification when a registration action occurs for it. |
| --notify-on-upload boolean | Triggers bundle notification when a upload action occurs for it. |
Delete Share Link Notification
Command
files-cli bundle-notifications delete
Output
No output is returned.
Authorization Requirement
Available to all authenticated keys or sessions.
Flags
| Flag | Description |
|---|---|
| --id= int64 Required | Bundle Notification ID. |
The BundleNotification Object
Some of the commands above return a BundleNotification object. The attributes of this object are listed below.
| Attribute | Description |
|---|---|
| bundle_id int64 | Bundle ID to notify on |
| id int64 | Bundle Notification ID |
| notify_on_registration boolean | Triggers bundle notification when a registration action occurs for it. |
| notify_on_upload boolean | Triggers bundle notification when a upload action occurs for it. |
| notify_current_user boolean | Is the current user the user to notify? |
| notify_user_id int64 | The id of the user to notify. |
| workspace_id int64 | Workspace ID. 0 means the default workspace. |