Docs

MyLINK Email API – Product Guide

The MyLINK Email API is a robust, secure, and scalable messaging product that enables developers to send and manage Email communications directly through LINK Mobility’s infrastructure. This guide will walk you through how to configure and monitor your Email API usage from the MyLINK Portal. For information regarding the API configuration, refer to API Reference.

Overview

The Email API is ideal for businesses requiring:

  • Reliable delivery of one-way Email messages.

  • Centralized control of credentials and usage quotas.

  • Insightful dashboards for traffic monitoring and log analysis.

  • Secure access management through the MyLINK Portal.

All actions can be performed within the MyLINK Portal, without the need to contact support, unless otherwise noted.

Create and Manage API Credentials

Before sending messages via the Email API, you must create API credentials tied to a specific account.

How to create credentials:

  1. Navigate to Email API Product in the MyLINK Portal.

  2. Click Create Credentials.

  3. Add the name of the credentials.

  4. A client ID and client secret will be generated — store them securely.

Additional credential management features:

  • Regenerate client secrets

  • Deactivate credentials

Dashboard Overview

The MyLINK Email Dashboard provides a comprehensive, real-time view of your messaging activity. It is designed to help you track delivery success, identify performance trends, and monitor key statistics related to your Email traffic.

Whether you're managing large campaigns or day-to-day transactional messaging, the dashboard offers full visibility into both outbound (MT) and inbound (MO) Email flows.

Metrics available:

  • Total messages sent

  • Total messages received

  • Delivery status breakdown (Delivery success, Delivery Failure, In Process)

  • Delivery failure breakdown (error status displayed)

  • Country-level traffic distribution

Use the built-in date range filter to analyze trends over time — up to 90 days.

Overview of Dashboard Components

1. Top-Level Summary Widgets

At the top of the dashboard, you’ll find summary boxes displaying the most important KPIs at a glance:

  • Messages Sent – Total Emails messages submitted.

  • Messages Delivered – Number of messages successfully delivered to recipients.

  • Open Rate – Number of open emails vs number of sent messages.

  • Click Rate – Number of clicked vs number of sent messages.

2. Traffic Breakdown Charts

These visual elements help you understand delivery trends and campaign impact over time.

  • Volume Over Time
    A time-series chart that shows how your traffic evolved. Useful for identifying spikes or delivery issues.

  • Status Distribution
    Visualize the ratio of Delivered vs Failed vs In Progress messages.

  • Delivery over time
    Visualizes the volume of successfully delivered messages over a selected time range.

  • Failures over time
    Displays failed message attempts across time.

  • Top Countries
    Discover which countries receive the most messages from your account.

3. Filtering & Customization

To help you drill down into specific data, a full set of filters is available across the dashboard:

  • Date Range
    Select from predefined ranges or custom periods.

  • Traffic Type
    Choose between MT, MO, or both.

  • Sender Name
    Filter results by specific alphanumeric sender or shortcode.

  • Country
    View traffic going to or coming from a specific destination.

  • Subaccount
    Focus on traffic by a specific customer/subaccount.

  • Status
    Filter messages by delivery status (Delivered, Failed, Rejected, etc.).

Export Options

You can export all dashboard metrics and charts as a CSV file using the Export button at the top right. This enables further offline analysis or reporting.

Message Logs Overview

The Logs section provides detailed visibility into every email sent through the MyLINK Email API. It supports tracking, troubleshooting, and verification by offering message-level transparency across your email operations.

Each log entry includes when the email was sent, who the sender and recipient were, and what delivery status it received.

Key Features of the Logs Interface

1. Search and Filtering

Quickly narrow down results using a variety of filters:

  • Date and time range

  • Sender email or recipient address

  • Message status (Delivered, Failed, Bounced, Queued, etc.)

  • Country

  • Credential or user

Filters can be combined to investigate specific events, diagnose delivery issues, or audit campaigns.

2. Table View

Each row in the table represents an individual email message with core details:

  • Timestamp of the event (in UTC or local time)

  • Sender and recipient email addresses

  • Subject line and message ID

  • Delivery status and final result

  • Channel: always Email in this context

  • User and credential information

Clicking a row opens the Message Details panel, which includes a full status timeline, message metadata, and headers (when available).

3. Export to CSV

You can export your filtered logs using the Export button.

What’s included:

  • All visible log fields

  • Only the data matching your current filters

  • Downloadable in .csv format for use in Excel or Google Sheets

Notes:

  • Exports may be limited in size for performance reasons.

  • Media or file attachments are not included.

  • Larger exports can be handled via API or through a support request if needed.

Delivery Reports (DLRs)

The DLRs View provides a focused list of all delivery report events sent to your configured callbacks, helping you confirm delivery status at scale.

DLRs are essential for confirming whether a message was delivered, buffered, failed, or expired.

Features

  • View per-message delivery events

  • Filter by:

    • Date/time

    • Delivery status

    • Recipient number

    • Credential or project

  • Check callback status codes (e.g., 200 OK, 400 error)

  • See retry attempts and failures

This helps technical teams debug delivery or endpoint issues quickly.

Template Management

The Templates section allows users to create, manage, and publish email templates directly from the portal. These templates are used when sending messages via the MyLINK Email API and are account-specific — meaning users only see templates for the account they’re logged into.

Templates Overview

Located in the side menu under Templates, this section includes:

  • Templates overview
    A list of all existing email templates, presented in a table format.

  • Create template
    Opens the email template editor to design a new message.

The table includes the following columns:

  • Name

  • Status (Draft / Published)

  • ID (copyable)

  • Channel

  • Tags

  • Creation and last modified date

  • Actions (Edit, Duplicate, Delete, Publish/Draft toggle)

Users can:

  • Search templates by name, content, or ID

  • Filter by tags

  • Sort templates by name, creation/modification date, or status

  • Customize visible columns (except for Actions, which is always shown)

Pagination is enabled when there are more than 10 templates. Rows expand to show all tags when needed.

Template Actions

From the Actions column, users can:

  • Edit: Opens the template in the visual editor

  • Duplicate: Opens a modal to rename and duplicate the selected template

  • Delete: Prompts a confirmation modal

  • Move to Draft / Publish: Toggle between publishable and draft state

Template Editor

Clicking Create template or Edit opens the visual editor (powered by a third-party tool) with a toolbar at the top:

  • Name field (editable, with uniqueness warnings)

  • Tags field (add, remove, or create new tags)

  • Send Preview button

  • Publish & Exit or Save as Draft & Exit

Templates are autosaved as you work. If a user attempts to leave the page without saving, a confirmation popup will appear — only if changes were made.

You can also:

  • Send a preview to a test email address

  • Monitor saving status via a spinner and “Saved” label

  • Manage template versions collaboratively (last saved version is preserved)

Domain Configuration

The Domain Configuration section allows users to configure and verify sender domains for use with the Email API. This setup is required to ensure message deliverability and compliance with sender authentication standards.

Domain Table

Accessible from the Email API navigation, this page displays a list of configured domains, including:

  • Domain name

  • DNS verification status

  • SPF and DKIM validation status

  • Last updated time

  • Status (Active, Pending)

Users can add a new domain by clicking Add Domain, which opens a modal where they input the domain name. The system then provides DNS records to be added (TXT for SPF, CNAME or TXT for DKIM).

Verification Process

Once the domain is added:

  1. The user receives DNS configuration instructions.

  2. After DNS is updated, the portal automatically checks the status.

  3. Verification status is shown as:

    • Verified

    • Pending

    • Error (with tooltip guidance)

Only verified domains can be used as sender addresses in email messages sent via the API.

MyLINK Portal | Product Guide