Email

Emails represent messages synced from connected email accounts in Lightfield. Read responses are privacy-aware and may be redacted based on the caller.

Retrieve an email

client.Email.Get(ctx, id) (*EmailRetrieveResponse, error)

GET/v1/emails/{id}

List emails

client.Email.List(ctx, query) (*EmailListResponse, error)

GET/v1/emails

Send an email

client.Email.Send(ctx, body) (*EmailSendResponse, error)

POST/v1/emails/send

Create a draft email

client.Email.Draft(ctx, body) (*EmailDraftResponse, error)

POST/v1/emails/draft

ModelsExpand Collapse

type EmailDraftResponse struct{…}

DraftedAt string

ISO 8601 timestamp of when the draft was created.

type EmailListResponse struct{…}

Data []EmailListResponseData

Array of email objects for the current page.

ID string

Unique identifier for the entity.

AccessLevel string

The caller’s resolved access level for this email.

One of the following:

const EmailListResponseDataAccessLevelFull EmailListResponseDataAccessLevel = "FULL"

const EmailListResponseDataAccessLevelMetadata EmailListResponseDataAccessLevel = "METADATA"

CreatedAt string

ISO 8601 timestamp of when the entity was created.

Fields map[string, EmailListResponseDataField]

Field map for this email. Does not include $body; retrieve the email by ID for message HTML.

Value EmailListResponseDataFieldValueUnion

The field value, or null if unset.

One of the following:

string

float64

bool

type EmailListResponseDataFieldValueArray []string

type EmailListResponseDataFieldValueAddress struct{…}

City stringOptional

City name.

Country stringOptional

2-letter ISO 3166-1 alpha-2 country code.

Latitude float64Optional

Latitude coordinate.

Longitude float64Optional

Longitude coordinate.

PostalCode stringOptional

Postal or ZIP code.

State stringOptional

State or province.

Street stringOptional

Street address line 1.

Street2 stringOptional

Street address line 2.

type EmailListResponseDataFieldValueFullName struct{…}

FirstName stringOptional

The contact’s first name.

LastName stringOptional

The contact’s last name.

ValueType string

The data type of the field.

One of the following:

const EmailListResponseDataFieldValueTypeAddress EmailListResponseDataFieldValueType = "ADDRESS"

const EmailListResponseDataFieldValueTypeCheckbox EmailListResponseDataFieldValueType = "CHECKBOX"

const EmailListResponseDataFieldValueTypeCurrency EmailListResponseDataFieldValueType = "CURRENCY"

const EmailListResponseDataFieldValueTypeDatetime EmailListResponseDataFieldValueType = "DATETIME"

const EmailListResponseDataFieldValueTypeEmail EmailListResponseDataFieldValueType = "EMAIL"

const EmailListResponseDataFieldValueTypeFullName EmailListResponseDataFieldValueType = "FULL_NAME"

const EmailListResponseDataFieldValueTypeMarkdown EmailListResponseDataFieldValueType = "MARKDOWN"

const EmailListResponseDataFieldValueTypeMultiSelect EmailListResponseDataFieldValueType = "MULTI_SELECT"

const EmailListResponseDataFieldValueTypeNumber EmailListResponseDataFieldValueType = "NUMBER"

const EmailListResponseDataFieldValueTypeSingleSelect EmailListResponseDataFieldValueType = "SINGLE_SELECT"

const EmailListResponseDataFieldValueTypeSocialHandle EmailListResponseDataFieldValueType = "SOCIAL_HANDLE"

const EmailListResponseDataFieldValueTypeTelephone EmailListResponseDataFieldValueType = "TELEPHONE"

const EmailListResponseDataFieldValueTypeText EmailListResponseDataFieldValueType = "TEXT"

const EmailListResponseDataFieldValueTypeURL EmailListResponseDataFieldValueType = "URL"

const EmailListResponseDataFieldValueTypeHTML EmailListResponseDataFieldValueType = "HTML"

HTTPLink string

URL to view the entity in the Lightfield web app, or null.

ObjectType string

Always email.

Relationships map[string, EmailListResponseDataRelationship]

Map of relationship names to their associated entities. System relationships are prefixed with $ (e.g. $owner, $contact).

Cardinality string

Whether the relationship is has_one or has_many.

ObjectType string

The type of the related object (e.g. account, contact).

Values []string

IDs of the related entities.

UpdatedAt string

ISO 8601 timestamp of when the entity was last updated, or null.

ExternalID stringOptional

External identifier for the entity, or null if unset.

Object string

The object type, always "list".

TotalCount int64

Total number of entities matching the query.

minimum0

maximum9007199254740991

type EmailRetrieveResponse struct{…}

ID string

Unique identifier for the entity.

AccessLevel EmailRetrieveResponseAccessLevel

The caller’s resolved access level for this email.

One of the following:

const EmailRetrieveResponseAccessLevelFull EmailRetrieveResponseAccessLevel = "FULL"

const EmailRetrieveResponseAccessLevelMetadata EmailRetrieveResponseAccessLevel = "METADATA"

CreatedAt string

ISO 8601 timestamp of when the entity was created.

Fields map[string, EmailRetrieveResponseField]

Map of field names to their typed values. System fields are prefixed with $ (e.g. $name, $email); custom attributes use their bare slug.

Value EmailRetrieveResponseFieldValueUnion

The field value, or null if unset.

One of the following:

string

float64

bool

type EmailRetrieveResponseFieldValueArray []string

type EmailRetrieveResponseFieldValueAddress struct{…}

City stringOptional

City name.

Country stringOptional

2-letter ISO 3166-1 alpha-2 country code.

Latitude float64Optional

Latitude coordinate.

Longitude float64Optional

Longitude coordinate.

PostalCode stringOptional

Postal or ZIP code.

State stringOptional

State or province.

Street stringOptional

Street address line 1.

Street2 stringOptional

Street address line 2.

type EmailRetrieveResponseFieldValueFullName struct{…}

FirstName stringOptional

The contact’s first name.

LastName stringOptional

The contact’s last name.

ValueType string

The data type of the field.

One of the following:

const EmailRetrieveResponseFieldValueTypeAddress EmailRetrieveResponseFieldValueType = "ADDRESS"

const EmailRetrieveResponseFieldValueTypeCheckbox EmailRetrieveResponseFieldValueType = "CHECKBOX"

const EmailRetrieveResponseFieldValueTypeCurrency EmailRetrieveResponseFieldValueType = "CURRENCY"

const EmailRetrieveResponseFieldValueTypeDatetime EmailRetrieveResponseFieldValueType = "DATETIME"

const EmailRetrieveResponseFieldValueTypeEmail EmailRetrieveResponseFieldValueType = "EMAIL"

const EmailRetrieveResponseFieldValueTypeFullName EmailRetrieveResponseFieldValueType = "FULL_NAME"

const EmailRetrieveResponseFieldValueTypeMarkdown EmailRetrieveResponseFieldValueType = "MARKDOWN"

const EmailRetrieveResponseFieldValueTypeMultiSelect EmailRetrieveResponseFieldValueType = "MULTI_SELECT"

const EmailRetrieveResponseFieldValueTypeNumber EmailRetrieveResponseFieldValueType = "NUMBER"

const EmailRetrieveResponseFieldValueTypeSingleSelect EmailRetrieveResponseFieldValueType = "SINGLE_SELECT"

const EmailRetrieveResponseFieldValueTypeSocialHandle EmailRetrieveResponseFieldValueType = "SOCIAL_HANDLE"

const EmailRetrieveResponseFieldValueTypeTelephone EmailRetrieveResponseFieldValueType = "TELEPHONE"

const EmailRetrieveResponseFieldValueTypeText EmailRetrieveResponseFieldValueType = "TEXT"

const EmailRetrieveResponseFieldValueTypeURL EmailRetrieveResponseFieldValueType = "URL"

const EmailRetrieveResponseFieldValueTypeHTML EmailRetrieveResponseFieldValueType = "HTML"

HTTPLink string

URL to view the entity in the Lightfield web app, or null.

ObjectType EmailRetrieveResponseObjectType

Always email.

Relationships map[string, EmailRetrieveResponseRelationship]

Map of relationship names to their associated entities. System relationships are prefixed with $ (e.g. $owner, $contact).

Cardinality string

Whether the relationship is has_one or has_many.

ObjectType string

The type of the related object (e.g. account, contact).

Values []string

IDs of the related entities.

UpdatedAt string

ISO 8601 timestamp of when the entity was last updated, or null.

ExternalID stringOptional

External identifier for the entity, or null if unset.

type EmailSendResponse struct{…}

SentAt string

ISO 8601 timestamp of when the send completed.