Email API

Understand how to use Netcore Email APIs (V6).

Overview

The Email API allows you to send, manage, and track emails within Netcore CPaaS dashboard. It supports sending transactional and triggered emails, managing templates, configuring domains, and more.

The API is designed for reliable, scalable email delivery and enables use cases such as password resets, order confirmations, notifications, and campaign sends.

This document introduces the endpoints of Email API V6, explains its key components, and demonstrates how they work together in a typical use case.


Base URLs by Region

Endpoints

Each endpoint is designed to handle a specific aspect of email communication:

1. Send Mail API

Enables sending of transactional or triggered emails using either raw content or predefined templates. Supports personalization, attachments, headers, and subaccount-based routing.

2. Template API

Allows you to create, retrieve, update, and manage reusable email templates. Templates support variable substitution and versioning for consistent communication.

3. Profile API

Manages sender identities including from-addresses, reply-to headers, and display names. Useful for aligning branding across communications.

4. Domain API

Handles domain verification and authentication setup (SPF, DKIM, DMARC). Ensures better deliverability and protection against spoofing.

5. API Keys & Scopes API

Provides secure access to the API using scoped API keys. Scopes can be configured for granular control, enabling separation of access across environments or teams.

6. Suppression API

Maintains suppression lists for hard bounces, complaints, and unsubscribes. Ensures compliance and protects sender reputation by preventing further sends to problematic recipients.

7. Webhook API

Enables asynchronous delivery event tracking. Events such as delivered, opened, clicked, bounced, and unsubscribed are pushed to your application in real time.

8. Batch API

Optimized for high-volume email operations. Allows sending a large number of emails in a single API call with recipient-level customization.

9. Stats API

Provides detailed analytics and metrics, including delivery rates, engagement (opens/clicks), bounce statistics, and suppression trends. Data can be filtered by subaccount, domain, or campaign.

10. Subaccounts API

Supports logical segmentation of accounts. Useful for organizations with multiple brands or clients, allowing each subaccount to manage its own configurations, templates, and stats independently.


Example Use Cases

Order Confirmation – E-commerce company

An e-commerce platform sends order confirmation emails post-purchase.

  • Template API: Defines dynamic templates with order details.
  • Profile API: Configures "[email protected]" as the sender.
  • Domain API: Authenticates domain for better deliverability.
  • Send Mail API: Triggers real-time emails with order-specific data.
  • Webhook API: Tracks opens, clicks, and delivery events.
  • Suppression API: Skips users who opted out or bounced.
  • Stats API: Monitors performance and delivery trends.
  • Subaccounts API: Separates brands or store fronts.
  • API Keys & Scopes API: Manages secure access for teams.

Statement Notification – BFSI company

A financial organisation sends monthly account statements.

  • Template API: Creates standardized, personalized statement formats.
  • Profile API: Uses verified "[email protected]" sender profile.
  • Domain API: Ensures domain authentication and compliance.
  • Batch API: Sends personalized statements at scale.
  • Webhook API: Provides real-time bounce and delivery tracking.
  • Suppression API: Prevents delivery to unsubscribed or invalid contacts.
  • Stats API: Tracks delivery metrics for audit and reporting.
  • Subaccounts API: Segregates communications by product line.
  • API Keys & Scopes API: Restricts access by role and function.

For integration support or access to test environments, please contact your Netcore Account Manager or write to us at [email protected].