Send from an inbox

202 with status. sent went to SES; pending_approval means the inbox holds agent mail for a human and NOTHING has been delivered yet; scheduled will send later. reply_to states which address replies go to and WHY — relay_fallback means the branded domain cannot yet receive, so correlation runs over the relay instead. suppressed lists recipients dropped because they bounced, complained or opted out.

post/inboxes/{id}/messages

Request

  • Base URL: https://worker.openhelm.ai/v1
  • URL: https://worker.openhelm.ai/v1/inboxes/{id}/messages
  • Auth: HTTP bearer

Path parameters

idstring required

Request body

tostring

One address or a list.

ccstring[]
bccstring[]
subjectstring required
body_markdownstring
body_htmlstring
textstring
from_namestring
reply_tostring

Overrides the correlation Reply-To. Doing so means replies no longer thread back automatically.

send_class'transactional' | 'agent' | 'marketing'

Which daily allowance this charges. Separate counters per class, so an outreach campaign can never starve a password reset. marketing and conversation-opening agent mail carry a one-click List-Unsubscribe header and are refused if the deployment has no unsubscribe secret. Absent ⇒ derived from the caller.

scheduled_atstring

RFC 3339. Held until then by the scheduler drainer.

client_idstring

Idempotency key — a repeat returns the original send.

attachmentsobject[]

{ filename, content_type, content_base64 }, 10 MB total.

reply_to_thread_idstring
in_reply_to_message_idstring
force_approvalboolean

Hold this message for human approval even when the inbox is auto.

Response

Accepted

Changes

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