v1

latestOpenAPI 3.0.12026-07-2491247233.8 KB
Messages

Create message

Create a new message data model from a raw message

post/v0/messages/create

Request body

canonical_idstring nullable

The canonical ID of the message, if known

external_created_atstring nullable

Timestamp the message created at according to the external source

external_message_idstring nullable

ID of the message according to the external source

external_thread_idstring nullable

ID of the thread the message belongs to according to the external source

folderstring nullable

The mailbox folder the message is in

labelsstring[]

Labels applied to the message by the mailbox

mailbox_email_addressstring email nullable

The email address of the mailbox containing this message

raw_messagestring byte required

The full base64 encoded raw eml message

route_typestring nullable

The directional route type of the message

Response

OK

canonical_group_idstring required

Identifier shared by messages with the same canonical_id that arrive within the same period without a 60-minute gap

canonical_idstring required

The sha1 hash of the message body text and sender

created_atstring required

Datetime the message was created

delivered_atstring date-time nullable

The time, if any, at which the message was delivered

effective_atstring date-time nullable

The effective time of the message

idstring uuid required

Message ID

mailbox_idstring uuid nullable

ID of the mailbox for the message

matched_global_exclusionboolean nullable

Whether or not the message matched a global exclusion rule

raw_message_idstring uuid required

ID of the raw message that generated this message

received_inlineboolean

Whether or not the message was received via inline processing

reports_as_phishstring nullable

ID of the message group this message reports as phish

reviewed_atstring nullable

Datetime the message was reviewed

statusstring nullable

The status of the message

status_changed_atstring date-time nullable

The time when the status last changed