Send Email

Whether the record has been soft-deleted or not.

The bulkemail with which this sendemail is associated.

NOTE: Parameter accepts additional qualifiers appended to the end:
bulk_email__in - The value for the record is in the provided array parameter (comma-separated values).
bulk_email__isnull - The value for the record is null (if true) or is not null.

Number of times links in email have been clicked

NOTE: Parameter accepts additional qualifiers appended to the end:
clicks__in - The value for the record is in the provided array parameter (comma-separated values).
clicks__gt, clicks__gte, clicks__lt, clicks__lte - The value for the record is greater than/less than (or equal to) the provided parameter.
clicks__isnull - The value for the record is null (if true) or is not null.

When the record was originally created.

NOTE: Parameter accepts additional qualifiers appended to the end:
created__year, created__month, created__day - The value for the record matches the provided year/month/day (note that week_day, hour, minute, and second are also available following similar patterns).

Send to email address. Nullable because push notifications don't use this.

NOTE: Parameter accepts additional qualifiers appended to the end:
email_address__in - The value for the record is in the provided array parameter (comma-separated values).
email_address__contains, email_address__icontains - The value for the record contains the string provided as a parameter within it (partial match). (Use 'icontains' for matching to be done case-insensitive)
email_address__startswith, email_address__istartswith - The value for the record starts with the string provided as a parameter. (Use 'istartswith' for matching to be done case-insensitive)
email_address__endswith, email_address__iendswith - The value for the record ends with the string provided as a parameter within it (partial match). (Use 'iendswith' for matching to be done case-insensitive)
email_address__iexact - The value for the record is a case-insensitive exact match to the provided parameter.
email_address__isnull - The value for the record is null (if true) or is not null.

timestamp for when the event occurred

NOTE: Parameter accepts additional qualifiers appended to the end:
first_open__year, first_open__month, first_open__day - The value for the record matches the provided year/month/day (note that week_day, hour, minute, and second are also available following similar patterns).

The Quorum primary key for this record; guaranteed to be persistent and unique across all objects at this endpoint.

the link -> count key

Number of times email has been opened

NOTE: Parameter accepts additional qualifiers appended to the end:
opens__in - The value for the record is in the provided array parameter (comma-separated values).
opens__gt, opens__gte, opens__lt, opens__lte - The value for the record is greater than/less than (or equal to) the provided parameter.
opens__isnull - The value for the record is null (if true) or is not null.

The newperson with which this sendemail is associated.

NOTE: Parameter accepts additional qualifiers appended to the end:
person__in - The value for the record is in the provided array parameter (comma-separated values).
person__isnull - The value for the record is null (if true) or is not null.

First and last name of email recipient

NOTE: Parameter accepts additional qualifiers appended to the end:
recipient_name__in - The value for the record is in the provided array parameter (comma-separated values).
recipient_name__contains, recipient_name__icontains - The value for the record contains the string provided as a parameter within it (partial match). (Use 'icontains' for matching to be done case-insensitive)
recipient_name__startswith, recipient_name__istartswith - The value for the record starts with the string provided as a parameter. (Use 'istartswith' for matching to be done case-insensitive)
recipient_name__endswith, recipient_name__iendswith - The value for the record ends with the string provided as a parameter within it (partial match). (Use 'iendswith' for matching to be done case-insensitive)
recipient_name__iexact - The value for the record is a case-insensitive exact match to the provided parameter.
recipient_name__isnull - The value for the record is null (if true) or is not null.

Whether the SendEmail has been sent

The datetime that this deliverable was sent

NOTE: Parameter accepts additional qualifiers appended to the end:
sent_datetime__year, sent_datetime__month, sent_datetime__day - The value for the record matches the provided year/month/day (note that week_day, hour, minute, and second are also available following similar patterns).

Status given by Sparkpost after email is sent

NOTE: Parameter accepts additional qualifiers appended to the end:
sparkpost_status__in - The value for the record is in the provided array parameter (comma-separated values).
sparkpost_status__contains, sparkpost_status__icontains - The value for the record contains the string provided as a parameter within it (partial match). (Use 'icontains' for matching to be done case-insensitive)
sparkpost_status__startswith, sparkpost_status__istartswith - The value for the record starts with the string provided as a parameter. (Use 'istartswith' for matching to be done case-insensitive)
sparkpost_status__endswith, sparkpost_status__iendswith - The value for the record ends with the string provided as a parameter within it (partial match). (Use 'iendswith' for matching to be done case-insensitive)
sparkpost_status__iexact - The value for the record is a case-insensitive exact match to the provided parameter.
sparkpost_status__isnull - The value for the record is null (if true) or is not null.

When the record was most recently updated.

NOTE: Parameter accepts additional qualifiers appended to the end:
updated__year, updated__month, updated__day - The value for the record matches the provided year/month/day (note that week_day, hour, minute, and second are also available following similar patterns).

Option to provide additional detail for certain fields, either by expanding those fields with additional details from the related model or by substituting more informative values for the actual database values.bulk_email - expand bulk_email with additional details.
NOTE: This parameter can accept one or more comma-separated values; it is not limited to a single value.

Perform an advanced text search on the datset with the provided text. This search will use the most comprehensive search method available on the requested endpoint, but can take slightly longer to return results.

The number of records to return (for pagination).