Send an email

$ lightfield email send

POST/v1/emails/send

Sends an email via the connected email account that owns the from address. Currently supports new sends only; replies and forwards are not yet supported.

Supports idempotency via the Idempotency-Key header.

Required scope: emails:create

Rate limit category: Write

ParametersExpand Collapse

--from: string

Bare email address (no display name). Must match a connected email account owned by the API key user. Compared case-insensitively. Used as the From header when sending.

--message-body: object { content, contentType }

Email message body (HTML or plain text).

--subject: string

Email subject. Cannot be empty.

--to: array of string

Recipient email addresses (bare, no display names). At least 1, at most 500.

--attachment: optional array of string

Optional list of file IDs (uploaded via the Files API) to attach to the email. Maximum 5 attachments per email. Gmail: up to 20 MiB combined raw attachment size. Outlook: up to 3 MiB per attachment. Uploads with purpose email_attachment accept up to 20 MiB per file; sender-specific limits apply when sending or creating a draft.

--bcc: optional array of string

Bcc recipients (same shape as to).

--cc: optional array of string

Cc recipients (same shape as to).

ReturnsExpand Collapse

email_send_response: object { sentAt }

sentAt: string

ISO 8601 timestamp of when the send completed.

Send an email

lightfield email send \
  --api-key 'My API Key' \
  --from sales@acme.com \
  --message-body "{content: '<p>Hi there,</p><p>Following up on our chat earlier this week.</p>'}" \
  --subject 'Following up on our chat' \
  --to lead@example.com

{
  "sentAt": "sentAt"
}

Returns Examples

{
  "sentAt": "sentAt"
}