Skip to main content
PATCH
Update email message

Authorizations

Authorization
string
header
required

Access token issued by gtm.service.id. Its access_identity claim carries team_sid, actor_sid and actor_type, and that team scope is authoritative.

Team-SID
string
header
required

Team scope for tokens that do not carry one. Ignored when the token already names a team.

Headers

Email-Box-SID
string

Email server (em_bx_...) the call is for, from search_email_boxes. Omitted: the primary server.

Pattern: ^em_bx_[A-Za-z0-9]{12}$

Path Parameters

sid
string
required

Path segment {sid}.

Required string length: 18
Pattern: ^em_ms_

Body

application/json

Request body of update_email_message.

is_read
boolean
is_flagged
boolean

Starred on Gmail, flagged on Microsoft and IMAP.

email_folder_sids
string[]

The full membership wanted, from search_email_folders of the same mailbox.

Required string length: 18
Pattern: ^em_fd_
client_reference
string | null

Your own key of the message; null clears it.

Maximum string length: 255

Response

update success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
update
item
object
required
updated_fields
string[]
required
previous_values
object
required
meta
object
required