Send an email from the org's identity

Sends transactionally from the org's DEFAULT address (orgname@relay.openhelm.ai). To send from a specific inbox — a product's own branded identity, or a named sender like noreply@ — use POST /inboxes/{id}/messages instead. The caller owns approval (e.g. an operator-approved body). Sets a correlation Reply-To so a reply threads back via the email.received webhook. metadata is an opaque object echoed verbatim on that webhook.

post/emails

Request

  • Base URL: https://worker.openhelm.ai/v1
  • URL: https://worker.openhelm.ai/v1/emails
  • Auth: HTTP bearer

Request body

ccstring[]
bccstring[]

Blind copies. Never written into a header the other recipients can read.

subjectstring required
body_markdownstring
body_htmlstring

Pre-rendered HTML; takes precedence over body_markdown.

textstring
from_namestring

Display name before the address (defaults to the org's name).

reply_tostring email

Overrides the correlation Reply-To; replies will NOT thread back.

client_idstring

Idempotency key — a repeat returns the original send instead of delivering twice.

metadataobject

Echoed on the reply webhook.

Response

Accepted

message_idstring
from_addressstring
correlation_tokenstring
status'sent' | 'scheduled' | 'pending_approval'
suppressedstring[]

Recipients dropped because they are suppressed (hard bounce / complaint). The message WAS delivered to everyone else. Empty on a clean send.

Changes

No recorded changes to this operation across all 1 revision of this API.