Skip to main content
Send emails using created email templates, supporting batch sending to multiple recipients. Each recipient can use different template variable parameters.

Request Information

  • Request Method: POST
  • Request Path: /api/v1/email/SendEmailTemplate
  • Content-Type: application/json (use multipart/form-data when uploading attachments)

Notes

  • TemplateVariableParams format: variableName{##}variableValue, multiple variables are separated by array elements
  • Cc and Bcc in each EmailContent item: combined count ≤ 100; CC/BCC recipients share the same template variable rendering from that item
  • Attachments: max 10 files, total size ≤ 10MB; when uploading attachments, switch to multipart/form-data — attach files as form file fields, no manual Base64 encoding needed
  • Headers: array of {Name, Value} objects, max 20; Name allows only letters, digits, and -; reserved names (From, To, Subject, Reply-To, Content-Type, Mime-Version, X-SES-* prefix) are not allowed; Value must not contain newlines
Fromstringrequired
Sender email address
?
TemplateIdstringrequired
?
EmailContentobject[]required
Email content array (each item: To, Cc, Bcc, TemplateVariableParams)
EmailContent Preview
This JSON will be assembled into the request body.
[
  {
    "To": "recipient@example.com",
    "Cc": [],
    "Bcc": [],
    "TemplateVariableParams": [
      "{1}{##}John",
      "{2}{##}123456"
    ]
  }
]
Recipient 1
FromNamestring
Sender nickname
?
PreHeaderstring
Preview summary text shown next to subject in inbox
?
Attachmentsfile
Attachment list (JSON), max 10 files, total ≤10MB; use multipart/form-data to upload
?
Headersstring
Custom email headers (JSON array of {Name, Value}), max 20
?

Response Format

Field NameTypeDescription
RetCodeintReturn code, 0 indicates success
MessagestringReturn message
SessionNostringSession number, used to query sending status
FailedTargetEmailsarrayList of failed recipients (each: EmailAddress, TemplateVariableParams, FailureReason)

Error Codes

CodeDescription
0Success
215392Invalid parameter
215397Missing required parameter
215400Server error

Update Notes (2026-07-28)

SendEmail / EmailContent[].EmailAddress / Abstract / top-level Cc/Bcc are deprecated — use From / EmailContent[].To / PreHeader / EmailContent[].Cc/Bcc instead. Old fields still work but new fields take priority when both are provided.

LANGUAGE

CREDENTIALS

👁️
🔒
🔑Log in to get ACCESSKEY_ID and ACCESSKEY_SECRET

URL

POST
CURL Request
curl -X POST "https://api.uspeedo.com/api/v1/email/SendEmailTemplate" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Basic $(echo -n 'ACCESSKEY_ID:ACCESSKEY_SECRET' | base64)" \
-d '{
"From": "sender@example.com",
"TemplateId": "template_123",
"EmailContent": [
{
"To": "recipient@example.com",
"TemplateVariableParams": [
"{1}{##}John",
"{2}{##}123456"
]
}
],
"FromName": "uSpeedo",
"PreHeader": "New user welcome email"
}'

RESPONSE

Click Try It! to start a request and see the response here.