User Additional Email Recipients
List User Additional Email Recipients
SDK Method
useradditionalemailrecipient.List()
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.
UserAdditionalEmailRecipientListParams Fields
| Field | Description |
|---|---|
| UserId 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.
UserAdditionalEmailRecipientFindParams Fields
| Field | 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.
UserAdditionalEmailRecipientCreateParams Fields
| Field | Description |
|---|---|
| UserId 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.
UserAdditionalEmailRecipientUpdateParams Fields
| Field | Description |
|---|---|
| Id int64 Required | User Additional Email Recipient ID. |
| 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.
UserAdditionalEmailRecipientDeleteParams Fields
| Field | Description |
|---|---|
| Id int64 Required | User Additional Email Recipient ID. |
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 |
| UserId int64 | User ID |
| WorkspaceId int64 | Workspace ID (0 for default workspace). |
| Email string | Additional email recipient address |
| CreatedAt date-time | Created at date/time |