post

/mail/send

Send Email API allows you to send emails to your recipients using your sending domain. Each API call will enable you to send an email to single or multiple recipients.
Pepipost processes your requests, generates emails using the values defined in the API request and sends the emails to the recipients.

The nucleus of the Send Email API is the personalizations object. The way you use the personalizations object would give you the flexibility to modify

  • the number of recipients who would receive the emails
  • the subject of the mail
  • the content of the mail
  • the recipients marked as a copy in Cc or Bcc.

The settings object allows you to configure the engagement tracking, scheduling information, global bcc and other advance control of your email delivery.

What is personalization?

You can use Send Email API to send a common content to multiple recipients, and personalizations aims to enable you to substitute few elements of your common content and personalize the email for recipients enlisted in a single personalization object.
With each personalization object, you can define a different set of recipients and modify the content with distinct values passed in attributes object.

Personalization enables you to send a unique email to each recipient set, derived from a shared template or content.

What are tags?

tags is a highly useful parameter which, when judiciously used, helps you to distinguish your emails in unique groups/segments.
If you are going to use Pepipost to send different type of emails, It makes sense to segment your emails and analyze the delivery & engagement performance for each segment. For instance - If you are sending signup confirmation and festive season offers through Pepipost, tags enable you to segregate those emails in two categories and provide you with the tag wise performance reports.

Request Parameters

1 Header

Request Body

1 Example
Schema
object
from
object

An object containing the email address and name of the sender.

reply_to
string

The email address to which recipients can reply back to.

subject
string

The subject of the email.
You can also personalize the subject line by passing the attribute key between [% %] identifier.

required
template_id
integer

The Id number associated with the template.
You can find the template Id in Settings->Templates

tags
array[string]

The keyword to associate this email request to a particular type of email communication.
Tagging helps in segregating emails for later reference.

content
array[object]

The content of the mail.

You can display dynamic values in content using identifiers such as [% NAME %] for NAME , [% AGE %] for AGE and passing dynamic values in attributes object.

required
attachments
array[object]

An array of objects to send emails with one or more attachments.

personalizations
array[object]

An object to forward the recipient details, pass dynamic values for personalization and send unique token values for each recipient type.

settings
object

An object parameter to configure the engagement tracking and scheduling.

bcc
array[object]

An object to define the recipient information who is marked a blind carbon copy of the email

schedule
integer

Indicate the time of email delivery using the Unix epoch time format.
Make sure to schedule your email within 72 hours from the time of request.

Responses

1 Example
Schema
object
data
object
message
string
status
string

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
$$.env
No $$.env variables are being used in this request.