User Additional Email Recipients
List User Additional Email Recipients
SDK Method
UserAdditionalEmailRecipient.List();
Return Object
FilesList<UserAdditionalEmailRecipient>
Authorization Requirement
Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.
Method Arguments
| Argument | Description |
|---|---|
| user_id int64 | User ID. Provide a value of 0 to operate the current session's user. |
Additional Arguments
Show User Additional Email Recipient
SDK Method
UserAdditionalEmailRecipient.Find();
Return Object
UserAdditionalEmailRecipient
Authorization Requirement
Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.
Method Arguments
| Argument | Description |
|---|---|
| id int64 Required | User Additional Email Recipient ID. |
Create User Additional Email Recipient
SDK Method
UserAdditionalEmailRecipient.Create();
Return Object
UserAdditionalEmailRecipient
Authorization Requirement
Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.
Method Arguments
| Argument | Description |
|---|---|
| user_id int64 | User ID. Provide a value of 0 to operate the current session's user. |
| email string Required | Additional email recipient address |
Update User Additional Email Recipient
SDK Method
userAdditionalEmailRecipient.Update();
Return Object
UserAdditionalEmailRecipient
Authorization Requirement
Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.
Method Arguments
| Argument | Description |
|---|---|
| email string | Additional email recipient address |
Delete User Additional Email Recipient
SDK Method
userAdditionalEmailRecipient.Delete();
Return Object
No return value.
Authorization Requirement
Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.
The UserAdditionalEmailRecipient Object
Some of the methods above return a UserAdditionalEmailRecipient object. The attributes of this object are listed below.
| Attribute | Description |
|---|---|
| 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 |