EmailModel

An Email represents a communication sent from one company to another. The creator of the email is identified
by the CompanyId field, recipient(s) by the EmailTo field, and cc recipient(s) by the 'EmailCC' field.
The Email Model represents an email and a number of different metadata attributes related to the creation,
storage, and ownership of the email.

Methods

Fields

emailId

uuid, read-only

The unique ID of this record, automatically assigned by Lockstep when this record is
added to the Lockstep platform.

threadId

uuid

The unique ID number of this email's conversation thread.

groupKey

uuid, read-only

The GroupKey uniquely identifies a single Lockstep Platform account. All records for this
account will share the same GroupKey value. GroupKey values cannot be changed once created.

For more information, see Accounts and GroupKeys.

companyId

uuid, nullable

The ID number of the company that created this email.

emailFrom

string, nullable, 0-200 characters

The email address for the sender of this email.

emailTo

string, nullable, 0-1000 characters

The email address for the recipient(s) of this email.

emailCC

string, nullable, 0-1000 characters

The email address for the CC recipient(s) of this email

emailSubject

string, nullable, 0-998 characters

The subject line of this email.

emailBody

string, nullable

The body content of this email.

sentDate

date-time, nullable

The date on which this email was sent.

isUnread

boolean

A status flag indicating if this email is unread.

isPriority

boolean

A status flag indicating if this email is priority status.

isSpam

boolean

A status flag indicating if this email is marked as spam.

created

date-time, read-only

The date on which this email was created.

createdUserId

uuid, read-only

The ID number of the user who created this email.

toBeSent

boolean

A status flag indicating if this email is to be sent.

customerId

uuid, nullable

The ID number of the customer that sent this email.

receivedTimeStamp

date-time, nullable

The date on which this email was received.

openedTimestamp

date-time, nullable

The date on which this email was opened.

viewCount

int32

The number of times this email was viewed.

appEnrollmentId

uuid, nullable, read-only

AppEnrollmentId for this record; used for mapping purposes.

externalEmailId

string, nullable, 0-250 characters

The id of the email in an external system if imported.

externalThreadId

string, nullable, 0-250 characters

The id of the email thread in an external system if imported.

emailBcc

string, nullable, 0-1000 characters

The email address(es) for the BCC recipient(s) of this email

sendType

string, nullable, 0-7 characters

The type message being sent (New, Reply, Forward) or null for messages not being sent.

modified

date-time, read-only

The date on which this email was modified.
Email modification should only be done by internal services.

modifiedUserId

uuid, read-only

The ID of the user who modified this email.
Email modification should only be done by internal services.

responseOriginId

uuid, nullable

If the message being sent is a reply or a forward, the id of the the email being replied to or forwarded.
Otherwise null.

responseOrigin

EmailModel, nullable, read-only

The email object associated with the response origin id.

notes

NoteModel[], nullable, read-only

All notes attached to this email.
To retrieve this collection, specify Notes in the "Include" parameter for your query.

attachments

AttachmentModel[], nullable, read-only

All attachments attached to this email.
To retrieve this collection, specify Attachments in the "Include" parameter for your query.

customFieldDefinitions

CustomFieldDefinitionModel[], nullable, read-only

All definitions attached to this email.
To retrieve this collection, specify CustomFieldValues in the "Include" parameter for your query.

customFieldValues

CustomFieldValueModel[], nullable, read-only

All values attached to this email.
To retrieve this collection, specify Attachments in the "Include" parameter for your query.


Did this page help you?