Version 1.2



Single Email Validation

NOTICE: This interface is accessible only for customers with enabled 'Email Validation Module'. For everyone else, this interface is unavailable.


Request Parameters:
Name Example Value Default Value Description Type Data Type Required
email jonh.doe@example.com null Email for validation body string(100)
auto_create true true Creates a new subscriber body boolean
first_name John null Subscriber's first name body string(50)
last_name Doe 'Email Username' Subscriber's last name body string(50)
reactivate true false Reactivates subscriber body boolean
list_id 82eaba02-1c49-48d1-942d-7eb32a3722d7 false Distribution list ID body string(38)
Request Example:
{
    "email": "john.doe@example.com",
    "auto_create": true,
    "first_name": "John",
    "last_name": "Doe",
    "reactivate": true
}
Example Request URL:
https://api.clevermonitor.com/v1.2/validation/email
Response Parameters:
Name Data Type Reference Description
email string(100) Validated email
validation_status integer(3) validation_status Validation status
subscriber_status integer(3) record_status Subscriber creation status
list_status integer(3) record_status List creation status
Response Messages:
Code Status Example Body
200 OK
{
    "mail": "john.doe@example.comt",
    "list_status": null,
    "subscriber_status": 200,
    "validation_status": 200
}

Bulk Email Validation

NOTICE: This interface is accessible only for customers with enabled 'Email Validation Module'. For everyone else, this interface is unavailable.

The maximum number of validated emails is 10 per request.


Request Parameters:
Name Example Value Default Value Description Type Data Type Required
emails empty Array of emails body array
emails: email john.doe@example.com null Email for validation body string(100)
emails: first_name John null Subscriber's first name body string(50)
emails: last_name Doe 'Email Username' Subscriber's last name body string(50)
auto_create true true Creates a new subscriber body boolean
reactivate true false Reactivates subscriber body boolean
list_id 82eaba02-1c49-48d1-942d-7eb32a3722d7 false Distribution list ID body string(38)
Request Example:
{
    "emails": [
        {
            "email": "john.doe@example.com",
            "first_name": "John",
            "last_name": "Doe"
        },
        {
            "email": "mike.johnson@example.com",
            "first_name": "Mike",
            "last_name": "Johnson"
        }
    ],
    "auto_create": true,
    "reactivate": true
}
Example Request URL:
https://api.clevermonitor.com/v1.2/validation/emails
Response Parameters:
Name Data Type Reference Description
success_counter integer(2) Count of successfully validated emails
error_counter integer(2) Count of unsuccessfully validated emails
processing_counter integer(2) Total validated emails
success_emails array Array of successfully emails
success_emails: email string(100) Validated email
success_emails: validation_status integer(3) validation_status Validation status
success_emails: subscriber_status integer(3) record_status Subscriber creation status
success_emails: list_status integer(3) record_status List creation status
error_emails array Array of unsuccessfully validated emails
error_emails: email string(100) Validated email
error_emails: validation_status integer(3) validation_status Validation status
error_emails: subscriber_status integer(3) record_status Subscriber creation status
error_emails: list_status integer(3) record_status List creation status
Response Messages:
Code Status Example Body
200 OK
{
    "error_counter": 1,
    "success_counter": 1,
    "processing_counter": 2,
    "success_emails": [
        {
            "email": "john.doe@example.com",
            "validation_status": 200,
            "list_status": 200,
            "subscriber_status": 200
        }
    ],
    "error_emails": [
        {
            "email": "mike.johnson@example.com",
            "validation_status": 400
        }
    ]
}

Batch Email Validation - Request

NOTICE: This interface is accessible only for customers with enabled 'Email Validation Module'. For everyone else, this interface is unavailable.

The maximum number of validated emails is 1.000 per request.


Request Parameters:
Name Example Value Default Value Description Type Data Type Required
emails empty Array of emails body array
emails: email john.doe@example.com null Email for validation body string(100)
emails: first_name John null Subscriber's first name body string(50)
emails: last_name Doe 'Email Username' Subscriber's last name body string(50)
auto_create false true Creates a new subscriber body boolean
reactivate true false Reactivates a subscriber body boolean
list_id 82eaba02-1c49-48d1-942d-7eb32a3722d7 false Distribution list ID body string(38)
Request Example:
{
    "emails": [
        {
            "email": "john.doe@example.com",
            "first_name": "John",
            "last_name": "Doe"
        },
        {
            "email": "mike.johnson@example.com",
            "first_name": "Mike",
            "last_name": "Johnson"
        }
    ],
    "auto_create": true,
    "reactivate": true
}
Example Request URL:
https://api.clevermonitor.com/v1.2/batch/validation/emails
Response Parameters:
Name Data Type Reference Description
id string(38) Batch validation ID
status string Batch validation status
Response Messages:
Code Status Example Body
200 OK
{
    "id": "82eaba02-1c49-48d1-942d-7eb32a3722d7",
    "status": "Batch is created"
}

Batch Email Validation - Response

NOTICE: This interface is accessible only for customers with enabled 'Email Validation Module'. For everyone else, this interface is unavailable.


Request Parameters:
Name Example Value Default Value Description Type Data Type Required
id 82eaba02-1c49-48d1-942d-7eb32a3722d7 null Batch validation ID formData string(38)
Example Request URL:
https://api.clevermonitor.com/v1.2/batch/validation/emails/82eaba02-1c49-48d1-942d-7eb32a3722d7
Response Parameters:
Name Data Type Reference Description
id string(38) Batch validation ID
status integer(1) batch_status Batch validation status
create_time ISO 8601 Timestamp of creation
finish_time ISO 8601 or null Timestamp of finish
total_emails integer(10) Count of all emails
finish_emails integer(10) Count of already validated emails
total_exists integer(10) Count of already existing emails
subscribers_new integer(10) Count of new subscribers
subscribers_exists integer(10) Count of already existing subscribers
subscribers_reactivate integer(10) Count of reactivated subscribers
exists_emails array Array of existing emails
exists_emails: email string(100) Validated email
exists_emails: validation_status integer(3) validation_status Validation status
exists_emails: subscriber_status integer(3) record_status Subscriber creation status
exists_emails: list_status integer(3) record_status List creation status
error_emails array Array of unsuccessfully validated emails
error_emails: email string(100) Validated email
error_emails: validation_status integer(3) validation_status Validation status
error_emails: subscriber_status integer(3) record_status Subscriber creation status
error_emails: list_status integer(3) record_status List creation status
Response Messages:
Code Status Example Body
200 OK
{
    "id": "706b822b-d106-bfed-2167-70d738782a03",
    "status": 8,
    "create_time": "2016-02-26T15:31:31+01:00",
    "finish_time": "2016-02-26T15:32:21+01:00",
    "total_emails": 2,
    "finish_emails": 2,
    "total_exists": 1,
    "total_errors": 1,
    "subscribers_new": 0,
    "subscriber_exists": 1,
    "subscribers_reactivate": 0,
    "exists_emails": [
        {
            "email": "john.doe@example.com",
            "validation_status": 200,
            "subscriber_status": 202,
            "list_status": 202
        }
    ],
    "error_emails": [
        {
            "email": "mike.johnson@example.com",
            "validation_status": 400,
            "subscriber_status": null,
            "list_status": null
        }
    ]
}

RFC Email Validation

NOTICE: This interface is accessible only for customers with enabled 'Email Validation Module'. For everyone else, this interface is unavailable.


Request Parameters:
Name Example Value Default Value Description Type Data Type Required
email john.doe@example.com null Email address path string(100)
Example Request URL:
https://api.clevermonitor.com/v1.2/validation/email/rfc/john.doe@example.com
Response Parameters:
Name Data Type Reference Description
email string(100) Email address
message string Message
Response Messages:
Code Status Example Body
200 OK
{
    "email": "john.doe@example.com",
    "message": "Email is valid!"
}

Copyright © CleverMonitor, 2017