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

Send transactional or promotional emails using your verified sending domain. Each call supports custom content, recipients, and delivery options.

2. Suppression APIs

Manage domains and email addresses to exclude from communication. Supports adding, removing, listing, and checking suppression status for domains and individual addresses.

3. Domain APIs

Manage sending domains: add, verify, delete, list, configure DNS (SPF, DKIM, envelope), and allocate domains to subaccounts. Ensures deliverability and DNS integrity.

4. Events API

Access detailed email activity logs with filters (date, event type, email attributes). Supports bulk log downloads, status monitoring, and historical analysis.

5. Subaccount APIs

Create, manage, and list subaccounts under a master account. Subaccounts operate independently in terms of credits, sending domains, suppression lists, and analytics. Enhances deliverability and segmentation.

6. Template APIs

Create, retrieve, update, delete, and list email templates. Templates include URL‑encoded HTML content with unique names, enabling consistent reuse across campaigns.

7. API Management (API Keys)

Create, read, update, and delete API keys. Manage access by assigning case‑sensitive scopes. Keys are shown only once upon creation; every request requires an Authorization header.

8. Scope API

Control access to API keys by assigning scopes. Facilitates fine‑grained permission control across API usage.

9. Profile API

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

10. IP Management API

For parent accounts, request, allocate, monitor, and configure dedicated IP addresses for delivery. This enhances deliverability, reputation control, and infrastructure flexibility. (Subaccounts cannot manage IPs directly.)

11. Webhook API

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

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