This schema describes objects returned by the Email endpoints.
Fields
| Field | Type | Required | Description |
|---|---|---|---|
id | string (uuid) | Yes | A Unique identifier (read-only) |
timestamp_created | string (date-time) | Yes | Timestamp when the email was added to our database. This is not the timestamp of the email itself, since the email could have been sent at a different time. Please check the timestamp_email field for the timestamp of the email. (read-only) |
timestamp_email | string (date-time) | Yes | The timestamp of the email, as provided by the email server. Please note that the timestamp is not always accurate, as it can be manipulated by the sender or the email server. (read-only) |
message_id | string | Yes | Unique email ID from the email server (read-only) |
subject | string | Yes | Subject line of the email message |
from_address_email | string (email), nullable | No | The sender email address, populated based on the eaccount (read-only) |
to_address_email_list | string | Yes | Comma-separated list of recipient email addresses |
cc_address_email_list | string, nullable | No | Comma-separated list of CC email addresses |
bcc_address_email_list | string, nullable | No | Comma-separated list of BCC email addresses |
reply_to | string, nullable | No | Reply-to email address |
body | object | Yes | An object containing the email body in HTML and text format (read-only) |
body.text | string | No | Text content of the email |
body.html | string | No | HTML content of the email |
organization_id | string (uuid) | Yes | The workspace ID (read-only) |
campaign_id | string (uuid), nullable | No | The id of the campaign that the email is associated with (it can be null for manually sent emails) |
subsequence_id | string (uuid), nullable | No | The id of the campaign subsequence that the email is associated with (it can be null for manually sent emails) |
list_id | string (uuid), nullable | No | The id of the list (if the lead is part of a list) |
lead | string, nullable | No | The email address of the lead that the email is associated with |
lead_id | string (uuid), nullable | No | The lead id (if any) |
eaccount | string | Yes | The email account that was used to send the email. This needs to be validated to make sure it exists in the user workspace |
ue_type | number, nullable | No | Email type based on the life cycle of the email. Possible values: 1 (Sent from campaign), 2 (Received), 3 (Sent), 4 (Scheduled) |
step | string, nullable | No | The campaign step that the email is associated with |
is_unread | number, nullable | No | Indicates if the email is unread |
is_auto_reply | number, nullable | No | Indicates if the email is an auto-reply. 0 (zero) - is false, and 1 is true (read-only) |
reminder_ts | string (date-time), nullable | No | Timestamp for the reminder. |
ai_interest_value | number, nullable | No | AI interest value |
ai_assisted | number, nullable | No | Indicates if AI assistance was used |
is_focused | number, nullable | No | Indicates if the email is focused (is in the primary tab in the Unibox) |
i_status | number, nullable | No | Indicates the interest status of the email |
thread_id | string (uuid), nullable | No | Identifier for the email thread. All the emails in the same thread have the same thread ID |
content_preview | string, nullable | No | A short preview of the email content (usually the first few lines of the email) |
attachment_json | object, nullable | No | Attachment metadata for the email. This field is null when there are no attachments. (read-only) |
attachment_json.files | array | No | |
attachment_json.files[].filename | string | No | Attachment file name |
attachment_json.files[].size | number | No | Attachment file size in bytes |
attachment_json.files[].type | string | No | Attachment MIME type |
attachment_json.files[].url | string (uri) | No | Download URL when available |
attachment_json.files[].error | string, nullable | No | Error description when the attachment failed to upload |
from_address_json | array, nullable | No | List of from address details |
to_address_json | array, nullable | No | List of to address details |
cc_address_json | array, nullable | No | List of CC address details |
ai_agent_id | string (uuid), nullable | No | ID of the AI agent that sent this email (if applicable) |