SMTP API

This API is only for transactional emails.
Version 1.2



Blacklist overview


Example Request URL:
https://smtpapi.clevermonitor.com/v1.2/blacklist/?count=100&offset=0
Response Parameters:
Name Data Type Reference Description
email string(100) Email
records array Records
records[]: message_id string(38) Message ID
records[]: subject string(200) Message subject
records[]: type string(15) [SPAM, UNSUBSCRIBE] Unsubscribe reason
records[]: create_time ISO8601 Timestamp of creation
Response Messages:
Code Status Example Body
200 OK
[
    {
        "email": "john.doe@example.com",
        "records": [
            {
                "message_id": "591d902ff342cb32d4003439",
                "subject": "My Subject",
                "create_time": "2017-05-22T10:34:55+00:00",
                "type": "UNSUBSCRIBE"
            }
        ]
    },
    {
        "email": "mike.johnson@example.com",
        "records": [
            {
                "message_id": "591d902ff342cb32d4003569",
                "subject": "My Subject",
                "create_time": "2017-05-22T10:34:55+00:00",
                "type": "SPAM"
            }
        ]
    }
]

Blacklist detail


Request Parameters:
Name Example Value Default Value Description Type Data Type Required
email john.doe@example.com Recipient email path string(100)
Example Request URL:
https://smtpapi.clevermonitor.com/v1.2/blacklist/john.doe@example.com
Response Parameters:
Name Data Type Reference Description
email string(100) Email
records array Records
records[]: message_id string(38) Message ID
records[]: subject string(200) Message subject
records[]: type string(15) [SPAM, UNSUBSCRIBE] Unsubscribe reason
records[]: create_time ISO8601 Timestamp of creation
Response Messages:
Code Status Example Body
200 OK
{
    "email": "john.doe@example.com",
    "records": [
        {
            "message_id": "591d902ff342cb32d4003439",
            "subject": "My Subject",
            "create_time": "2017-05-22T10:34:55+00:00",
            "type": "UNSUBSCRIBE"
        }
    ]
}

Remove email from Blacklist


Request Parameters:
Name Example Value Default Value Description Type Data Type Required
email john.doe@example.com Recipient email path string(100)
Example Request URL:
https://smtpapi.clevermonitor.com/v1.2/blacklist/john.doe@example.com
Response Parameters:
Name Data Type Reference Description
email string(100) Email
Response Messages:
Code Status Example Body
200 OK
{
    "email": "john.doe@example.com"
}

Copyright © CleverMonitor, 2017