Email API

send an email

API endpoint URL for non-EU customers - https://emailapi.netcorecloud.net/

API endpoint for EU customers - https://apieu.netcorecloud.net/

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. <br> Email API 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?<br>

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.<br> 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?<br>

tags is a highly useful parameter which, when judiciously used, helps you to distinguish your emails in unique groups/segments.<br> If you are going to use Email API 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 Email API, tags enable you to segregate those emails in two categories and provide you with the tag wise performance reports.

post/mail/send

Request

  • Base URL
    https://emailapi.netcorecloud.net/v5.1
  • URL
    https://emailapi.netcorecloud.net/v5.1/mail/send
  • Auth
    API key in header api_key

Headers

api_keystring required

Your Email API Key. You can find this in your Email account at Settings->Integrations.

Request body

reply_tostring

The email address to which recipients can reply back to.

subjectstring required

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

template_idinteger

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

tagsstring[]

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

scheduleinteger

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

Response

Email sent successfully

messagestring
statusstring

Changes

No recorded changes to this operation across all 1 revision of this API.