API docs by Redocly

MainBrainer Email API

Download OpenAPI specification:

MainBrainer: support@mainbrainer.com URL: https://www.mainbrainer.com License: License Terms Terms of Service

MainBrainer Email API for public

Email

Send Single Email

Send Email API

This endpoint is especially useful for sending recipient-specific one-time alert emails or updates. Note that this API uses the promotional route for sending the emails. Kindly ensure that your emails are optimally designed to protect your sender reputation.

The emails can be sent immediately or can be scheduled for delivery at a later date and time.

Authorizations:
Bearer
Request Body schema:
required

This endpoint is used to send a single email to a single recipient.

object (Recipients)

Target recipient for the email sending.

required
object (EmailAddress)

Sender details to help the email recipients identify who sent them the email.

required
object (EmailAddress)

Sender details to help the email recipients identify who sent them the email.

subject
required
string

The text that you would like to appear in the email's subject field. Personalization Substitution Tags will work in the subject line to insert dynamic data for each recipient.

preHeaderText
string or null

The text you would like to appear in the email's preheader area, i.e., the area after the subject line. It is possible to personalize the preheader text using Personalization Substitution Tags.

emailBody
string or null

If you are designing your email in HTML, encode it into Base 64 format and pass it as the parameter value.

scheduleDateTime
string or null <date-time>

The scheduled date and time for the email sending in RFC3339 format (Y-m-d TH:i:sP).

emailCampaignId
string or null <uuid>
Default: "00000000-0000-0000-0000-000000000000"

Email Campaign ID of the email you want to send. Email Campaign ID is the unique identifier for an email campaign created in your MainBrainer account.

webHookUrl
string or null

The webhook URL where you want to receive delivery status updates for the email being sent.

Responses

Request samples

Content type
{
  • "recipient": {
    },
  • "senderFrom": {
    },
  • "replyTo": {
    },
  • "subject": "string",
  • "preHeaderText": "string",
  • "emailBody": "string",
  • "scheduleDateTime": "2019-08-24T14:15:22Z",
  • "emailCampaignId": "00000000-0000-0000-0000-000000000000",
  • "webHookUrl": "string"
}

Response samples

Content type
{
  • "queueId": "string",
  • "QueuedTimestamp": 0
}

Send Batch Email

Send Bulk Email to your Contacts

This endpoint is used to send an email to multiple recipients in one go and is especially useful for sending out email marketing campaigns like promotions for upcoming sales, special discount coupons, or event promotions, etc., to your contact lists.

Note: that this API uses the promotional route for sending the emails. Kindly ensure that your emails are optimally designed to protect your sender reputation.

The emails can be sent immediately or can be scheduled for delivery at a later date and time.

Authorizations:
Bearer
Request Body schema:
required

This endpoint is used to send an email to multiple recipients in one go.

object (BatchSendingDetails)

Details to define the email you wish to send, and the list of contacts to which you wish to send the email.

Array of objects or null (Recipients)

Details to define the email you wish to send, and the list of contacts to which you wish to send the email.

Responses

Request samples

Content type
{
  • "sendingDetails": {
    },
  • "recipients": [
    ]
}

Response samples

Content type
{
  • "queueId": "string",
  • "QueuedTimestamp": 0
}

Send Predefined Email

Trigger Email sendings on the basis of pre-saved templates

This endpoint is used to trigger email sendings on the basis of pre-saved email trigger templates. Email trigger templates allow you to save all the details necessary to trigger template an email sending as a template. These templates contain all the email sending details like the Sender name, the Sender email, the email subject and preheader texts, the email campaign that you wish to send, etc.

Authorizations:
Bearer
Request Body schema:
required

The emails can be sent immediately or can be scheduled for delivery at a later date and time.

predefinedTemplateId
required
string

The template ID of the email trigger template saved on MainBrainer. The Email sending details are fetched as per the details saved under this specified template ID.

listId
Array of strings or null <uuid> [ items <uuid > ]

List ID of the CRM contact list to which you wish to send the email. If you wish to send the email to multiple contact lists, pass the relevant List IDs as an array.

scheduleDateTime
string or null <date-time>

The scheduled date and time for the email sending in RFC3339 format (Y-m-d TH:i:sP).

Array of objects or null (Recipients)

Target recipient for the email sending.

webHookUrl
string or null

The webhook URL where you want to receive delivery status updates for the email being sent.

Responses

Request samples

Content type
{
  • "predefinedTemplateId": "string",
  • "listId": [
    ],
  • "scheduleDateTime": "2019-08-24T14:15:22Z",
  • "recipients": [
    ],
  • "webHookUrl": "string"
}

Response samples

Content type
{
  • "queueId": "string",
  • "QueuedTimestamp": 0
}

Get Email Delivery Status

Retrieve the delivery status of the sent Email(s).

Use this endpoint to retrieve the delivery status updates for the sent Email(s) in an easily parsable JSON format. The response will include the following delivery statuses as per the latest status of the sent Email:

  • Processed
  • Dropped
  • Deferred
  • Bounce
  • Delivered
  • Open
  • Click
  • Spam Report
  • Unsubscribe
Authorizations:
Bearer
path Parameters
id
required
string <uuid>

The queueId value received as response from the endpoints Email/Send Batch, Email/Single send, and Predefined Template SMS Send.

Responses

Response samples

Content type
{
  • "Id": "string",
  • "Status": 0,
  • "StatusText": "string",
  • "StatusFailedReason": "string",
  • "Details": [
    ]
}