Skip to main content
POST
/
subaccount
/
email
/
template
JavaSript
const { EmailApi, EmailMessage } = require('sendpost_js');
const email = new EmailApi();
const apiKey = 'your_api_key'; // {String} Sub-Account API Key

(async function() {
  const message = new EmailMessage();
  message.from = { email: '[email protected]' };

  message.to = [{
    email: '[email protected]',
    cc: [{ email: '[email protected]' }],
    bcc: [{ email: '[email protected]' }],
  }]

  message.subject = 'Hello'
  message.htmlBody = '<strong>it works!</strong>';
  message.ippool = 'PiedPiper'

  message.template = 'Welcome Mail'

  const opts = {
    emailMessage: message
  };
  try {
    const data = await email.sendEmailWithTemplate(apiKey, opts)
    console.log('API called successfully. Returned data: ', data);
  } catch (error) {
    console.error(error);
  }
})()
[
  {
    "to": "<string>",
    "submittedAt": 123,
    "messageId": "<string>",
    "errorCode": 123,
    "message": "<string>"
  }
]

Authorizations

X-SubAccount-ApiKey
string
header
required

This api key can be used only for sub account level operations

Body

application/json

Email message details with template information

from
object
replyTo
object
to
object[]
subject
string
preText
string
htmlBody
string
textBody
string
ampBody
string
ippool
string
headers
object
trackOpens
boolean
trackClicks
boolean
groups
string[]
attachments
object[]
webhookEndpoint
string
template
string
templateId
string

Template ID for the email template

templateVariables
object

Key-Value pair of template variables

Response

200 - application/json

A list of email message response objects.

to
string
submittedAt
integer<int64>

UNIX epoch nano timestamp

messageId
string

Message UUID

errorCode
integer
message
string