Create a draft email

$ lightfield email draft

POST/v1/emails/draft

Creates a draft in the connected email account that owns the from address. Mirrors native email-client behavior: only from is required — to, cc, bcc, subject, messageBody, and attachments are all optional. At least one of those optional fields must be populated; sending only from returns a 400.

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. Mailbox where the draft is created.

--attachment: optional array of string

Optional list of file IDs (uploaded via the Files API) to attach to the draft. Maximum 5 attachments per draft. 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).

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

Email message body (HTML or plain text).

--subject: optional string

Email subject.

--to: optional array of string

Recipient email addresses (bare, no display names). Up to 500.

ReturnsExpand Collapse

email_draft_response: object { draftedAt }

draftedAt: string

ISO 8601 timestamp of when the draft was created.

Create a draft email

lightfield email draft \
  --api-key 'My API Key' \
  --from sales@acme.com

{
  "draftedAt": "draftedAt"
}

Returns Examples

{
  "draftedAt": "draftedAt"
}