Share Groups

A ShareGroup is a way for you to store and name groups of email contacts to be used for sending share and inbox invitations.

List Share Groups

Command

files-cli share-groups list

Output

Outputs a list of ShareGroup objects according to the output format.

Authorization Requirement

Available to all authenticated keys or sessions.

Flags

FlagDescription
--user-id=
int64		User ID. Provide a value of 0 to operate the current session's user.

Additional Arguments

Example Request

files-cli share-groups list \
  --user-id=1

Show Share Group

Command

files-cli share-groups find

Output

Outputs a ShareGroup object according to the output format.

Authorization Requirement

Available to all authenticated keys or sessions.

Flags

FlagDescription
--id=
int64
Required		Share Group ID.

Example Request

files-cli share-groups find \
  --id=1

Create Share Group

Command

files-cli share-groups create

Output

Outputs a ShareGroup object according to the output format.

Authorization Requirement

Available to all authenticated keys or sessions.

Flags

FlagDescription
--user-id=
int64		User ID. Provide a value of 0 to operate the current session's user.
--notes=
string		Additional notes of the share group
--name=
string
Required		Name of the share group
--members=
array(object)
Required		A list of share group members.

Example Request

files-cli share-groups create \
  --name="Test group 1"

Update Share Group

Command

files-cli share-groups update

Output

Outputs a ShareGroup object according to the output format.

Authorization Requirement

Available to all authenticated keys or sessions.

Flags

FlagDescription
--id=
int64
Required		Share Group ID.
--notes=
string		Additional notes of the share group
--name=
string		Name of the share group
--members=
array(object)		A list of share group members.

Example Request

files-cli share-groups update \
  --id=1 \
  --notes="This group is defined for testing purposes"

Delete Share Group

Command

files-cli share-groups delete

Output

No output is returned.

Authorization Requirement

Available to all authenticated keys or sessions.

Flags

FlagDescription
--id=
int64
Required		Share Group ID.

Example Request

files-cli share-groups delete \
  --id=1

The ShareGroup Object

Some of the commands above return a ShareGroup object. The attributes of this object are listed below.

AttributeDescription
id
int64		Share Group ID
name
string		Name of the share group
notes
string		Additional notes of the share group
user_id
int64		Owner User ID
members
array(object)		A list of share group members

members

Contacts in this share group. Creating a share group requires at least one member. An update replaces the members with this list, and an empty list leaves them unchanged. Existing members are matched by email and keep their stored email address.

Value typeDescription
array of objectsContacts in this share group. Creating a share group requires at least one member. An update replaces the members with this list, and an empty list leaves them unchanged. Existing members are matched by email and keep their stored email address.

Example members

[
  {
    "name": "John Doe",
    "company": "Acme Ltd",
    "email": "johndoe@example.com"
  }
]