Emails represent messages synced from connected email accounts in Lightfield, and emails you log through the API. Read responses are privacy-aware and may be redacted based on the caller.
Delete a logged email
Restore a logged email
ModelsExpand Collapse
type EmailDeleteResponse struct{…}
Fields map[string, EmailDeleteResponseField]Map of field names to their typed values. System fields are prefixed with $ (e.g. $name, $email); custom attributes use their bare slug.
Map of field names to their typed values. System fields are prefixed with $ (e.g. $name, $email); custom attributes use their bare slug.
Value EmailDeleteResponseFieldValueUnionThe field value, or null if unset.
The field value, or null if unset.
ValueType stringThe data type of the field.
The data type of the field.
Relationships map[string, EmailDeleteResponseRelationship]Map of relationship names to their associated entities. System relationships are prefixed with $ (e.g. $owner, $contact). A self-referential relationship keeps its merged values and includes optional directional values. List filters select the current record’s role with :asSource or :asDestination, for example ?parent:asSource[contains]=account_id.
Map of relationship names to their associated entities. System relationships are prefixed with $ (e.g. $owner, $contact). A self-referential relationship keeps its merged values and includes optional directional values. List filters select the current record’s role with :asSource or :asDestination, for example ?parent:asSource[contains]=account_id.
Directions EmailDeleteResponseRelationshipDirectionsOptionalDirectional values for a self-referential relationship. List filters use the relationship key with :asSource or :asDestination; writes continue to use the bare key.
Directional values for a self-referential relationship. List filters use the relationship key with :asSource or :asDestination; writes continue to use the bare key.
AsDestination EmailDeleteResponseRelationshipDirectionsAsDestinationThe current record is the destination (incoming) endpoint.
The current record is the destination (incoming) endpoint.
type EmailListResponse struct{…}
Data []EmailListResponseDataArray of email objects for the current page.
Array of email objects for the current page.
Fields map[string, EmailListResponseDataField]Field map for this email. Does not include $body; retrieve the email by ID for message HTML.
Field map for this email. Does not include $body; retrieve the email by ID for message HTML.
Value EmailListResponseDataFieldValueUnionThe field value, or null if unset.
The field value, or null if unset.
ValueType stringThe data type of the field.
The data type of the field.
Relationships map[string, EmailListResponseDataRelationship]Map of relationship names to their associated entities. System relationships are prefixed with $ (e.g. $owner, $contact). A self-referential relationship keeps its merged values and includes optional directional values. List filters select the current record’s role with :asSource or :asDestination, for example ?parent:asSource[contains]=account_id.
Map of relationship names to their associated entities. System relationships are prefixed with $ (e.g. $owner, $contact). A self-referential relationship keeps its merged values and includes optional directional values. List filters select the current record’s role with :asSource or :asDestination, for example ?parent:asSource[contains]=account_id.
Directions EmailListResponseDataRelationshipDirectionsOptionalDirectional values for a self-referential relationship. List filters use the relationship key with :asSource or :asDestination; writes continue to use the bare key.
Directional values for a self-referential relationship. List filters use the relationship key with :asSource or :asDestination; writes continue to use the bare key.
AsDestination EmailListResponseDataRelationshipDirectionsAsDestinationThe current record is the destination (incoming) endpoint.
The current record is the destination (incoming) endpoint.
AsSource EmailListResponseDataRelationshipDirectionsAsSourceThe current record is the source (outgoing) endpoint.
The current record is the source (outgoing) endpoint.
type EmailLogResponse struct{…}
Fields map[string, EmailLogResponseField]Map of field names to their typed values. System fields are prefixed with $ (e.g. $name, $email); custom attributes use their bare slug.
Map of field names to their typed values. System fields are prefixed with $ (e.g. $name, $email); custom attributes use their bare slug.
Relationships map[string, EmailLogResponseRelationship]Map of relationship names to their associated entities. System relationships are prefixed with $ (e.g. $owner, $contact). A self-referential relationship keeps its merged values and includes optional directional values. List filters select the current record’s role with :asSource or :asDestination, for example ?parent:asSource[contains]=account_id.
Map of relationship names to their associated entities. System relationships are prefixed with $ (e.g. $owner, $contact). A self-referential relationship keeps its merged values and includes optional directional values. List filters select the current record’s role with :asSource or :asDestination, for example ?parent:asSource[contains]=account_id.
Directions EmailLogResponseRelationshipDirectionsOptionalDirectional values for a self-referential relationship. List filters use the relationship key with :asSource or :asDestination; writes continue to use the bare key.
Directional values for a self-referential relationship. List filters use the relationship key with :asSource or :asDestination; writes continue to use the bare key.
AsDestination EmailLogResponseRelationshipDirectionsAsDestinationThe current record is the destination (incoming) endpoint.
The current record is the destination (incoming) endpoint.
type EmailRestoreResponse struct{…}
Fields map[string, EmailRestoreResponseField]Map of field names to their typed values. System fields are prefixed with $ (e.g. $name, $email); custom attributes use their bare slug.
Map of field names to their typed values. System fields are prefixed with $ (e.g. $name, $email); custom attributes use their bare slug.
Value EmailRestoreResponseFieldValueUnionThe field value, or null if unset.
The field value, or null if unset.
ValueType stringThe data type of the field.
The data type of the field.
Relationships map[string, EmailRestoreResponseRelationship]Map of relationship names to their associated entities. System relationships are prefixed with $ (e.g. $owner, $contact). A self-referential relationship keeps its merged values and includes optional directional values. List filters select the current record’s role with :asSource or :asDestination, for example ?parent:asSource[contains]=account_id.
Map of relationship names to their associated entities. System relationships are prefixed with $ (e.g. $owner, $contact). A self-referential relationship keeps its merged values and includes optional directional values. List filters select the current record’s role with :asSource or :asDestination, for example ?parent:asSource[contains]=account_id.
Directions EmailRestoreResponseRelationshipDirectionsOptionalDirectional values for a self-referential relationship. List filters use the relationship key with :asSource or :asDestination; writes continue to use the bare key.
Directional values for a self-referential relationship. List filters use the relationship key with :asSource or :asDestination; writes continue to use the bare key.
AsDestination EmailRestoreResponseRelationshipDirectionsAsDestinationThe current record is the destination (incoming) endpoint.
The current record is the destination (incoming) endpoint.
type EmailRetrieveResponse struct{…}
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.
Map of field names to their typed values. System fields are prefixed with $ (e.g. $name, $email); custom attributes use their bare slug.
Value EmailRetrieveResponseFieldValueUnionThe field value, or null if unset.
The field value, or null if unset.
ValueType stringThe data type of the field.
The data type of the field.
Relationships map[string, EmailRetrieveResponseRelationship]Map of relationship names to their associated entities. System relationships are prefixed with $ (e.g. $owner, $contact). A self-referential relationship keeps its merged values and includes optional directional values. List filters select the current record’s role with :asSource or :asDestination, for example ?parent:asSource[contains]=account_id.
Map of relationship names to their associated entities. System relationships are prefixed with $ (e.g. $owner, $contact). A self-referential relationship keeps its merged values and includes optional directional values. List filters select the current record’s role with :asSource or :asDestination, for example ?parent:asSource[contains]=account_id.
Directions EmailRetrieveResponseRelationshipDirectionsOptionalDirectional values for a self-referential relationship. List filters use the relationship key with :asSource or :asDestination; writes continue to use the bare key.
Directional values for a self-referential relationship. List filters use the relationship key with :asSource or :asDestination; writes continue to use the bare key.
AsDestination EmailRetrieveResponseRelationshipDirectionsAsDestinationThe current record is the destination (incoming) endpoint.
The current record is the destination (incoming) endpoint.
AsSource EmailRetrieveResponseRelationshipDirectionsAsSourceThe current record is the source (outgoing) endpoint.
The current record is the source (outgoing) endpoint.