Modify an Email

Modifies the folder(s) and/or provider-specific properties on the specified Email.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length ≥ 1

ID of the Email to modify.

string
required
^acc_(.*)$

ID of the Account (acc_xxx) to call the method on behalf of.

Body Params
folders_ids
array of strings

The ID(s) of the folder(s) to apply, overwriting all folders previously associated with the Email. Outlook emails can be in a single folder only. Google allows a single email to appear in multiple folders. For Gmail, SENT and DRAFT are ignored: this operation cannot add or remove them, and their existing membership is preserved whether they are included or omitted. UNREAD is also ignored and read status is preserved; use the mark-as-read or mark-as-unread operation to change it. Gmail accepts an empty list to remove all labels except UNREAD, SENT and DRAFT and thus "archive" the email.

folders_ids
specifics
object

Object containing provider-specific email modification data.

Response

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json