## Log an email

`client.email.log(EmailLogParamsbody, RequestOptionsoptions?): EmailLogResponse`

**post** `/v1/emails/log`

Logs an email that no connected account will sync, such as history from a previous CRM or a mailbox export. The email appears on account, contact, and opportunity timelines at `$sentAt` and threads with related emails. `$sentAt` must be in the past, and at least one participant must be a workspace member and one must be external.

The `Message-ID` header (or a generated one) identifies the email. If an email with the same `Message-ID` already exists, the request returns 409 and writes nothing. Group emails into threads with `$threadId`, or pass `In-Reply-To` and `References` in `headers`.

Privacy defaults to the most permissive setting among the participants’ connected accounts, else `METADATA`. Set `$privacySetting` to override it. Logging an email never sends it, never cancels a sequence enrollment, and creates records only when `autoCreateRecords` is true. Filter out personal and non-sales mail before logging.

Supports idempotency via the `Idempotency-Key` header.

**[Required scope](/using-the-api/scopes/):** `emails:create`

**[Rate limit category](/using-the-api/rate-limits/):** Write

### Parameters

- `body: EmailLogParams`

  - `fields: Fields`

    Field values for the logged email. System fields use a `$` prefix. Required: `$sentAt` and `$from`, plus at least one recipient across `$to`, `$cc`, and `$bcc`.

    - `"$from": string`

      The sender address. This field accepts a single email address.

    - `"$sentAt": string`

      When the email was sent, in ISO 8601 format. Must be in the past.

    - `"$bcc"?: Array<string>`

      Bcc-recipient addresses.

    - `"$body"?: Body`

      The email body. Pass whichever parts you have.

      - `html?: string`

        The HTML part of the email.

      - `text?: string`

        The plain-text part of the email.

    - `"$cc"?: Array<string>`

      Cc-recipient addresses.

    - `"$privacySetting"?: "FULL" | "METADATA" | null`

      The privacy setting for the email (`FULL` or `METADATA`). Defaults to the most permissive setting among the participants’ connected accounts, else `METADATA`.

      - `"FULL"`

      - `"METADATA"`

    - `"$subject"?: string`

      The email subject line.

    - `"$threadId"?: string`

      Any stable grouping key. Emails with the same value share a thread. Overrides threading derived from `headers`.

    - `"$to"?: Array<string>`

      To-recipient addresses.

  - `autoCreateRecords?: boolean`

    When true, the post-create sync may create account and contact records for unknown external participants.

  - `headers?: Record<string, string>`

    Raw RFC 5322 headers, passed through as read (any key case). Only `Message-ID`, `In-Reply-To`, and `References` are used. At most 64 KB.

### Returns

- `EmailLogResponse`

  - `id: string`

    Unique identifier for the entity.

  - `accessLevel: "FULL" | "METADATA"`

    The caller's resolved access level for this email.

    - `"FULL"`

    - `"METADATA"`

  - `createdAt: string`

    ISO 8601 timestamp of when the entity was created.

  - `fields: Record<string, Fields>`

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

    - `value: string | number | boolean | 3 more | null`

      The field value, or null if unset.

      - `string`

      - `number`

      - `boolean`

      - `Array<string>`

      - `Address`

        - `city?: string | null`

          City name.

        - `country?: string | null`

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

        - `latitude?: number | null`

          Latitude coordinate.

        - `longitude?: number | null`

          Longitude coordinate.

        - `postalCode?: string | null`

          Postal or ZIP code.

        - `state?: string | null`

          State or province.

        - `street?: string | null`

          Street address line 1.

        - `street2?: string | null`

          Street address line 2.

      - `FullName`

        - `firstName?: string | null`

          The contact's first name.

        - `lastName?: string | null`

          The contact's last name.

    - `valueType: "ADDRESS" | "CHECKBOX" | "CURRENCY" | 12 more`

      The data type of the field.

      - `"ADDRESS"`

      - `"CHECKBOX"`

      - `"CURRENCY"`

      - `"DATETIME"`

      - `"EMAIL"`

      - `"FULL_NAME"`

      - `"MARKDOWN"`

      - `"MULTI_SELECT"`

      - `"NUMBER"`

      - `"SINGLE_SELECT"`

      - `"SOCIAL_HANDLE"`

      - `"TELEPHONE"`

      - `"TEXT"`

      - `"URL"`

      - `"HTML"`

  - `httpLink: string | null`

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

  - `objectType: "email"`

    Always `email`.

    - `"email"`

  - `relationships: Record<string, Relationships>`

    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`.

    - `cardinality: string`

      Whether the relationship is `has_one` or `has_many`.

    - `objectType: string`

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

    - `values: Array<string>`

      IDs of the related entities.

    - `directions?: Directions`

      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: AsDestination`

        The current record is the destination (incoming) endpoint.

        - `cardinality: "HAS_ONE" | "HAS_MANY"`

          Whether this endpoint direction is `HAS_ONE` or `HAS_MANY`.

          - `"HAS_ONE"`

          - `"HAS_MANY"`

        - `values: Array<string>`

          IDs of the related entities in this direction.

      - `asSource: AsSource`

        The current record is the source (outgoing) endpoint.

        - `cardinality: "HAS_ONE" | "HAS_MANY"`

          Whether this endpoint direction is `HAS_ONE` or `HAS_MANY`.

          - `"HAS_ONE"`

          - `"HAS_MANY"`

        - `values: Array<string>`

          IDs of the related entities in this direction.

  - `updatedAt: string | null`

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

  - `externalId?: string | null`

    External identifier for the entity, or null if unset.

### Example

```typescript
import Lightfield from 'lightfield';

const client = new Lightfield({
  apiKey: 'My API Key',
});

const emailLogResponse = await client.email.log({ fields: { $from: '$from', $sentAt: '$sentAt' } });

console.log(emailLogResponse.id);
```

#### Response

```json
{
  "id": "eml_cm0abc456def789",
  "accessLevel": "FULL",
  "createdAt": "2026-05-01T09:00:00.000Z",
  "fields": {
    "$subject": {
      "value": "Following up on our chat",
      "valueType": "TEXT"
    },
    "$sentAt": {
      "value": "2026-05-01T08:30:00.000Z",
      "valueType": "DATETIME"
    },
    "$from": {
      "value": [
        "sales@acme.com"
      ],
      "valueType": "EMAIL"
    },
    "$to": {
      "value": [
        "lead@example.com"
      ],
      "valueType": "EMAIL"
    },
    "$cc": {
      "value": [
        "string"
      ],
      "valueType": "EMAIL"
    },
    "$bcc": {
      "value": [
        "string"
      ],
      "valueType": "EMAIL"
    },
    "$privacySetting": {
      "value": "string",
      "valueType": "TEXT"
    },
    "$body": {
      "value": "<p>Hi there,</p><p>Following up on our chat earlier this week.</p>",
      "valueType": "HTML"
    }
  },
  "httpLink": null,
  "objectType": "email",
  "relationships": {
    "$account": {
      "cardinality": "has_many",
      "objectType": "account",
      "values": [
        "acc_cm4stu901uvw234"
      ],
      "directions": {
        "asDestination": {
          "cardinality": "HAS_ONE",
          "values": [
            "string"
          ]
        },
        "asSource": {
          "cardinality": "HAS_ONE",
          "values": [
            "string"
          ]
        }
      }
    },
    "$contact": {
      "cardinality": "has_many",
      "objectType": "contact",
      "values": [
        "con_cm2ghi789jkl012"
      ],
      "directions": {
        "asDestination": {
          "cardinality": "HAS_ONE",
          "values": [
            "string"
          ]
        },
        "asSource": {
          "cardinality": "HAS_ONE",
          "values": [
            "string"
          ]
        }
      }
    }
  },
  "updatedAt": "2026-05-01T10:00:00.000Z",
  "externalId": "externalId"
}
```