User Additional Email Recipients

List User Additional Email Recipients

Command

files-cli user-additional-email-recipients list

Output

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

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

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 user-additional-email-recipients list \
  --user-id=1

Show User Additional Email Recipient

Command

files-cli user-additional-email-recipients find

Output

Outputs a UserAdditionalEmailRecipient object according to the output format.

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Flags

FlagDescription
--id=
int64
Required		User Additional Email Recipient ID.

Example Request

files-cli user-additional-email-recipients find \
  --id=1

Create User Additional Email Recipient

Command

files-cli user-additional-email-recipients create

Output

Outputs a UserAdditionalEmailRecipient object according to the output format.

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Flags

FlagDescription
--user-id=
int64		User ID. Provide a value of 0 to operate the current session's user.
--email=
string
Required		Additional email recipient address

Example Request

files-cli user-additional-email-recipients create \
  --email="user-copy@example.com"

Update User Additional Email Recipient

Command

files-cli user-additional-email-recipients update

Output

Outputs a UserAdditionalEmailRecipient object according to the output format.

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Flags

FlagDescription
--id=
int64
Required		User Additional Email Recipient ID.
--email=
string		Additional email recipient address

Example Request

files-cli user-additional-email-recipients update \
  --id=1 \
  --email="user-copy@example.com"

Delete User Additional Email Recipient

Command

files-cli user-additional-email-recipients delete

Output

No output is returned.

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Flags

FlagDescription
--id=
int64
Required		User Additional Email Recipient ID.

Example Request

files-cli user-additional-email-recipients delete \
  --id=1

The UserAdditionalEmailRecipient Object

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

AttributeDescription
id
int64		User additional email recipient ID
user_id
int64		User ID
workspace_id
int64		Workspace ID (0 for default workspace).
email
string		Additional email recipient address
created_at
date-time		Created at date/time