Skip to main content
PATCH

Authorizations

X-API-KEY
string
header
required

Your access token, from your dashboard under API keys.

Path Parameters

email_id
string
required

The email's email_… id.

Body

application/json
unread
boolean

false marks it read.

starred
boolean

Flag (IMAP) or star (Gmail).

folder
string

Move it: a fld_… id, provider folder id, or role such as ARCHIVE, INBOX, SPAM.

Response

The updated email.

object
enum<string>
Available options:
Email,
Draft
id
string

email_…; stays the same when the email moves.

account_id
string
provider_id
string
message_id
string
thread_id
string
date
string<date-time>
subject
string
snippet
string
body
string
body_plain
string
from_attendee
object
to_attendees
object[]
cc_attendees
object[]
bcc_attendees
object[]
reply_to_attendees
object[]
in_reply_to
object | null
references
string[]
folders
string[]
folder_ids
string[]
role
enum<string>
Available options:
INBOX,
SENT,
DRAFTS,
TRASH,
SPAM,
ARCHIVE,
ALL,
IMPORTANT,
STARRED,
UNKNOWN
unread
boolean
starred
boolean
has_attachments
boolean
attachments
object[]
size
integer
origin
enum<string>

api: sent through this API.

Available options:
api,
external
tracking_id
string | null

Open/click tracking of this email (trk_…).

draft_id
string

Drafts only.

headers
object[]