This API operation can manage an email of a user by marking it as spam, deleting it or moving it to a custom folder.
GET
/v1/Email/Manage
GET
/v1/Groups/Email/Manage
(See Group manager)
Property | Type | Description |
---|---|---|
EmailID |
integer | Required. The ID of the email. |
Spam |
boolean |
When set to |
Delete |
boolean | If you want to delete this email set it to true . |
MoveFolderID |
integer | The ID of folder you which to move the email to. |
If the authenticated user is the manager of a group, the user can impersonate another member of the group. This allows the manager to perform tasks of other group members without having to authenticate as them.
The request can be build in the same way as the regular request, but targeted towards the Group manager endpoint. Additionally, it has the following extra parameters:
Property | Type | Description |
---|---|---|
UserID |
integer | Required. The ID of a member in the group that will be impersonated for this request. |
Parameters can be passed to this operation using the HTTP GET method by passing parameters over the query string of the URI.
The REST API uses HTTP request headers to determine what data type is returned or to authenticate the developer's API key. More information can be found in the overview section.
An Authorization header is required with every request and must contain the access_token of the user. More information can be found in the Access tokens page.
This endpoint requires the following scope:
Scope |
---|
account_communications |
Property | Type | Description |
---|---|---|
This will return no model just a 200 OK HTTP Status code. |
The following example shows a sample returned by the API.