Skip to main content

Send an email

POST 

/emails

Queue an email for delivery. The email is processed asynchronously and you'll receive a message ID to track its status.

You can provide content directly via html/text fields, or use a template by specifying template_id and template_data.

CAN-SPAM compliance — actions required from you:

  • Set classification to transactional or marketing. Unclassified is treated as marketing, the stricter reading. Transactional mail (password resets, receipts) is exempt from the opt-out and postal-address requirements.
  • Set your postal address in project settings. Commercial email must carry a valid physical postal address — the most commonly missed CAN-SPAM element. Marketing sends without one are flagged.
  • Include an unsubscribe mechanism on commercial email. Zyphr enforces suppression automatically once someone opts out, but the link itself is yours to include.

See Compliance Requirements.

Request

Responses

Email accepted for delivery

Response Headers
    X-Account-Sending-Status

    The account's current sending state. Present on every authenticated response. One of active, throttled, or frozen.

    X-Account-Sending-Status-Reason

    Human-readable reason for a non-active sending status. Present only when X-Account-Sending-Status is throttled or frozen.