Subaccount API

Use this API to integrate into your onboarding flows, and billing systems for automated email subaccount management.

Overview

The Subaccount API lets you create and manage email subaccounts under your primary Netcore account. Each subaccount acts as an isolated email workspace with its own credit balance and operational status.

This API is useful for teams and platforms that send email on behalf of multiple clients, brands, or business units. This API is especially useful when you need separate credit control and lifecycle management for each.

What Problem This API Solves

When sending email at scale for multiple brands, you typically need to:

  • Separate email sending credits by client or brand.
  • Control which subaccounts are allowed to send email.
  • Monitor email credit balances per subaccount.
  • Deactivate unused or non-compliant senders.

The Email Subaccount API provides a structured way to manage this programmatically rather than through manual console operations.

Endpoints

Refer to the given table to know the endpoints available for the Subaccount Email API.

EndpointMethodDescription
Create a subaccountPOSTCreates a new email subaccount under your primary account so a client or brand can send emails with isolated credits and controls.
Update a subaccountPOSTUpdates subaccount details such as name or configuration when account ownership or labeling changes.
Add credits to a subaccountPOSTAdds one-time email credits to a subaccount so it can continue sending emails immediately.
Set recurring creditsPOSTConfigures automatic recurring credit allocation for a subaccount to support continuous email sending without manual recharge.
Get credit detailsGETReturns the current email credit balance and credit-related details for a specific subaccount.
Retrieve list of subaccountsGETFetches all email subaccounts under the primary account for administrative views, reporting, or audits.
Enable/disable a subaccountPATCHEnables or blocks a subaccount from sending emails without deleting it. Useful for temporary suspension or compliance control.
Delete a subaccountDELETEPermanently removes an email subaccount that is no longer needed.

Use Case: Managing Email Sending for Multiple Client Brands

Scenario: A marketing automation platform sends transactional and campaign emails for multiple client brands. Each brand must have its own email credit pool and sending control.

Below is a typical lifecycle using the Email Subaccount API.

Step 1: Subaccount Creation

When a new client brand is onboarded, your backend automatically provisions an email subaccount.

Endpoint used: Create a subaccount

This creates a dedicated email sending unit with separate credit tracking.

Step 2: Email Credit Allocation

Before sending begins, you allocate email credits to the subaccount.

Endpoints used:

  • Add credits to a subaccount for initial email credit allocation
  • Set recurring credits to automatically top up credits monthly or weekly

This ensures uninterrupted email sending.

Step 3: Monitoring Email Credits

Your admin system checks available credits and usage across all brands.

Endpoints used:

  • Get credit details to fetch current email credit balance
  • Retrieve list of subaccounts to power admin dashboards and reports

This helps prevent email sending failures due to low credits.

Step 4: Sending Control

If a brand violates the sending policy or needs temporary suspension, you can stop email sending without removing the setup.

Endpoint used: Enable/disable a subaccount

This pauses sending while preserving configuration and history.

Step 5: Offboarding a Brand

When a client stops using your platform, you remove their email subaccount.

Endpoint used: Delete a subaccount

This permanently removes the email subaccount.