v1

latestOpenAPI 3.1.02026-07-2617125852.3 KB

Patch email

Requires one of the following scopes: emails:update, emails:all, all:update, all:all

patch/api/v2/emails/{id}

Path parameters

idstring uuid required

Example:019f94cd-ae86-7c48-a697-a1107efb2b77

The ID of the item to update

Request body

is_unreadnumber nullable

Indicates if the email is unread

reminder_tsstring date-time nullable

Timestamp for the reminder.

Example request

{
  "is_unread": 1,
  "reminder_ts": "2026-07-24T15:45:24.444Z"
}

Response

The updated Email

idstring uuid required

A Unique identifier

timestamp_createdstring date-time required

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.

timestamp_emailstring date-time required

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.

message_idstring required

Unique email ID from the email server

subjectstring required

Subject line of the email message

from_address_emailstring email nullable

The sender email address, populated based on the eaccount

to_address_email_liststring required

Comma-separated list of recipient email addresses

cc_address_email_liststring nullable

Comma-separated list of CC email addresses

bcc_address_email_liststring nullable

Comma-separated list of BCC email addresses

reply_tostring nullable

Reply-to email address

organization_idstring uuid required

The workspace ID

campaign_idstring uuid nullable

The id of the campaign that the email is associated with (it can be null for manually sent emails)

subsequence_idstring uuid nullable

The id of the campaign subsequence that the email is associated with (it can be null for manually sent emails)

list_idstring uuid nullable

The id of the list (if the lead is part of a list)

leadstring nullable

The email address of the lead that the email is associated with

lead_idstring uuid nullable

The lead id (if any)

eaccountstring required

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_type1 | 2 | 3 | 4 nullable

Email type based on the life cycle of the email

stepstring nullable

The campaign step that the email is associated with

is_unreadnumber nullable

Indicates if the email is unread

is_auto_replynumber nullable

Indicates if the email is an auto-reply. 0 (zero) - is false, and 1 is true

reminder_tsstring date-time nullable

Timestamp for the reminder.

ai_interest_valuenumber nullable

AI interest value

ai_assistednumber nullable

Indicates if AI assistance was used

is_focusednumber nullable

Indicates if the email is focused (is in the primary tab in the Unibox)

i_statusnumber nullable

Indicates the interest status of the email

thread_idstring uuid nullable

Identifier for the email thread. All the emails in the same thread have the same thread ID

content_previewstring nullable

A short preview of the email content (usually the first few lines of the email)

{"stackTrail":"components:schemas:Email:properties:from_address_json","oasType":"schema","type":"unknown","description":"List of from address details"}

{"stackTrail":"components:schemas:Email:properties:to_address_json","oasType":"schema","type":"unknown","description":"List of to address details"}

{"stackTrail":"components:schemas:Email:properties:cc_address_json","oasType":"schema","type":"unknown","description":"List of CC address details"}

ai_agent_idstring uuid nullable

ID of the AI agent that sent this email (if applicable)

Example response

{
  "id": "019f94cd-83dc-7a33-bb74-3dab6085f19c",
  "timestamp_created": "2026-07-24T15:45:24.444Z",
  "timestamp_email": "2026-07-24T15:45:24.444Z",
  "message_id": "<example123@mail.gmail.com>",
  "subject": "Re: Your inquiry",
  "from_address_email": "sender@example.com",
  "to_address_email_list": "recipient@example.com",
  "cc_address_email_list": "cc@example.com",
  "bcc_address_email_list": "bcc@example.com",
  "reply_to": "replyto@example.com",
  "body": {
    "text": "This is a test email",
    "html": "<p>This is a test email</p>"
  },
  "organization_id": "019f94cd-83dc-7a33-bb74-3dac64c56a27",
  "campaign_id": "019f94cd-83dc-7a33-bb74-3daded4fd3d0",
  "subsequence_id": "019f94cd-83dc-7a33-bb74-3daeb18d1836",
  "list_id": "019f94cd-83dc-7a33-bb74-3daf4f6d254a",
  "lead": "jondoe@example.com",
  "lead_id": "019f94cd-83dc-7a33-bb74-3db0055cb74b",
  "eaccount": "eaccount-123",
  "ue_type": 3,
  "step": "step-123",
  "is_unread": 1,
  "reminder_ts": "2026-07-24T15:45:24.444Z",
  "ai_interest_value": 0.75,
  "ai_assisted": 1,
  "is_focused": 1,
  "thread_id": "019f94cd-83dc-7a33-bb74-3db1037a0918",
  "content_preview": "This is a preview of the email content.",
  "attachment_json": {
    "files": [
      {
        "filename": "attachment",
        "size": 1927,
        "type": "text/css",
        "url": "https://cdn.instantly.ai/example-attachment/",
        "error": null
      }
    ]
  },
  "ai_agent_id": "019f94cd-83dc-7a33-bb74-3db29c8a7faf"
}