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

SDK Method

files_sdk.share_group.list()

Return Object

ListObj[ShareGroup]

Authorization Requirement

Available to all authenticated keys or sessions.

Method Arguments

ArgumentDescription
user_id
int64		User ID. Provide a value of 0 to operate the current session's user.

Additional Arguments

Example Request

import files_sdk

try:
  share_groups = files_sdk.share_group.list({
    "user_id": 1
  })
  for share_group in share_groups.auto_paging_iter():
    print(share_group.get_attributes())
except files_sdk.error.NotAuthenticatedError as err:
  print(f"Authentication Error Occurred ({type(err).__name__}):", err)
except files_sdk.error.Error as err:
  print(f"Unknown Error Occurred ({type(err).__name__}):", err)

Show Share Group

SDK Method

files_sdk.share_group.find()

Return Object

ShareGroup

Authorization Requirement

Available to all authenticated keys or sessions.

Method Arguments

ArgumentDescription
id
int64
Required		Share Group ID.

Example Request

import files_sdk

try:
  share_group = files_sdk.share_group.find(id)
  # Operate on share_group
except files_sdk.error.NotAuthenticatedError as err:
  print(f"Authentication Error Occurred ({type(err).__name__}):", err)
except files_sdk.error.Error as err:
  print(f"Unknown Error Occurred ({type(err).__name__}):", err)

Create Share Group

SDK Method

files_sdk.share_group.create()

Return Object

ShareGroup

Authorization Requirement

Available to all authenticated keys or sessions.

Method Arguments

ArgumentDescription
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

import files_sdk

try:
  share_group = files_sdk.share_group.create({
    "name": "Test group 1",
    "members": [{"name": "John Doe", "company": "Acme Ltd", "email": "johndoe@example.com"}]
  })
  # Operate on share_group
except files_sdk.error.NotAuthenticatedError as err:
  print(f"Authentication Error Occurred ({type(err).__name__}):", err)
except files_sdk.error.Error as err:
  print(f"Unknown Error Occurred ({type(err).__name__}):", err)

Update Share Group

SDK Method

share_group.update()

Return Object

ShareGroup

Authorization Requirement

Available to all authenticated keys or sessions.

Method Arguments

ArgumentDescription
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

import files_sdk

try:
  # Find the share_group object by its id.
  share_group = files_sdk.share_group.find(id)
  share_group.update({
    "notes": "This group is defined for testing purposes"
  })
except files_sdk.error.NotAuthenticatedError as err:
  print(f"Authentication Error Occurred ({type(err).__name__}):", err)
except files_sdk.error.Error as err:
  print(f"Unknown Error Occurred ({type(err).__name__}):", err)

Delete Share Group

SDK Method

share_group.delete()

Return Object

No return value.

Authorization Requirement

Available to all authenticated keys or sessions.

Example Request

import files_sdk

try:
  # Find the share_group object by its id.
  share_group = files_sdk.share_group.find(id)
  share_group.delete()
except files_sdk.error.NotAuthenticatedError as err:
  print(f"Authentication Error Occurred ({type(err).__name__}):", err)
except files_sdk.error.Error as err:
  print(f"Unknown Error Occurred ({type(err).__name__}):", err)

The ShareGroup Object

Some of the methods 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"
  }
]