Simple
Email Marketing
Platform

Open a Mailpro account and enjoy
100 FREE Credits

Mailpro API

List

Description

Get a listing of all Transactional Messages.

Method

Get

Call

Base URL
https://api.mailpro.com/v2/transactionalEmail/list.xml
Name
Mandatory
Description
IdClient
YES
This is a unique ID to identify the client
ApiKey
YES
This is a GUID to identify the client and to access the API
NameFilter
NO
Text to filter the results
NumberOfRecords
NO
By Default: 60 Items. Order by update date Desc. If PageNumber
is used, it determines the page size (number of records per page)
PageNumber
NO
Indicates the requested page number. It’s necessary to use with the
parameter NumberOfRecords

Result

API list address book

Result Attributes

Name
Description
TransactionalEmails[] Contains list of transactional messages
    TransactionalEmail[] Identify each transactional message
        Id ID of the transactional message
        MessageId ID of the message
        Name Name of the transactional message
        UpdateDate Update date
        FolderId Folder Id
        Enabled Status (1: Enabled
0: Disabled)
        EventType Event type (0: Date in address book field
1: Event in address book
2: After email sent)
        EventMetadata1 For event type 0 and 1: Address book Id
For event type 2: Campaign Id
        EventMetadata2 For event type 0: Field number
For event type 1: “Suscribed”/”Unsuscribed”
For event type 2: Condition
        EventMetadata3 For event type 0: Date format
For event type 1: NA (not applied)
For event type 2: Type
        EventMetadata4 For event type 0: Date format separator
For event type 1: NA (not applied)
For event type 2: Link in message
        EventMetadata5 For event type 0: Time format
For event type 1: NA (not applied)
For event type 2: NA (not applied)
        EventMetadata6 For event type 0: Date mode (“0”: Send immediately / “1”: Next occurrence of the date (one time
only) / “2”: All next occurrences of the date (anniversary) / “3”: Do not send if date in past)
For event type 1: NA (not applied)
For event type 2: NA (not applied)
        Color Color
        Subject Subject
        ExpEmailId Sender Email Id
        ExpEmailReplyId Reply to Email Id
        UnsubscribeListId Id of unsubscribe address book
        Immediately Send immediately? 1 for True / 0 for False
        NumberOfDays The number of delayed days to deliver the message
        Time The time for deliver the message

SIMPLE EMAIL MARKETING PLATFORM

Open a Mailpro account and enjoy 500 free credits