v1.0.0
OAS 3.1.0

Email Service

This is a FastAPI microservice for sending emails using a set email provider.

Client Libraries

Send Email

Body
  • from_email
    Type:string | nullable

    From email address override the default from email address if configured.

  • to_addresses
    Type:array string[]
    required

    List of email addresses to send the email to.

    Example["user1@example.com", "user2@example"]
  • subject
    Type:string
    required
  • text_body
    Type:string
    required
  • html_body
    Type:string | nullable
  • reply_to
    Type:array | nullable

    List of reply-to email addresses.

Responses
Request Example forPOST/send-email
curl /send-email \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "from_email": "",
  "to_addresses": [
    "user1@example.com",
    "user2@example"
  ],
  "subject": "",
  "text_body": "",
  "html_body": "",
  "reply_to": []
}'
{
  "status": true
}

Models