Documentation Powered by ReDoc

Email Academy API (1.0.0)

Download OpenAPI specification:Download

Email Academy API provides the usage of its various tools through an API

Tool Limits

Tool Limits

Get tool usage Limits

Each tool has its own usage limits. This endpoint provides the current usage and limits for the given tool.

query Parameters
api_key
required
string
Example: api_key=your-api-key

The user's API key

tool
required
string
Enum: "blacklist_checker" "email_verifier" "bounce_code_analyzer" "inbox_tester" "spfdkim_tester" "rdns_tester" "blacklist_monitor" "website_monitor"
Example: tool=email_verifier

The name of the tool

Responses

Request samples 

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'api.emailacademy.com/v1/tool-limits?api_key=your-api-key&tool=email_verifier',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Response samples

Content type
application/json
{
  • "limit": 500,
  • "used": 325,
  • "period": "monthly"
}

Blacklist Checker

Blacklist checker

Validate IP or domain

Validate an IP or domain through various blacklists

Request Body schema: application/json

Request parameters for blacklist checker

host
string

The domain or IP

api_key
string

The user's API key

Responses

Request samples

Content type
application/json
{
  • "api_key": "your-api-key",
  • "host": "example.com"
}

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Validate IP or domain

Validate an IP or domain through various blacklists

query Parameters
api_key
required
string
Example: api_key=your-api-key

The user's API key

host
required
string
Example: host=example.com

The domain or IP

Responses

Request samples 

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'api.emailacademy.com/v1/blacklist?api_key=your-api-key&host=example.com',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Analyze a file

Upload a file of IPs and domains for blacklist check

Request Body schema: multipart/form-data

Request parameters for uploading a file

file
required
any <binary>

The file containing the IPs and domains

api_key
required
string

The user's API key

Responses

Request samples 

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'api.emailacademy.com/v1/blacklist/file/check',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => array('api_key' => 'your-api-key','file'=> new CURLFILE('/path/to/file')),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Response samples

Content type
application/json
{
  • "file_id": "1628750661SHYNuWITqYoeWc"
}

Get file information

Get a list of files with detailed information of the files

query Parameters
api_key
required
string
Example: api_key=your-api-key

The user's API key

offset
string
Example: offset=5

Optional offset for pagination. Defaults to 0

count
string
Example: count=15

Optional count for pagination. Defaults to 10

file_id
string
Example: file_id=1628750661SHYNuWITqYoeWc

Optional file ID filter. Exact file ID must be given.

file_name
string
Example: file_name=bounce

Optional file name filter. The given string will be looked up in the file name.

Responses

Request samples 

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'api.emailacademy.com/v1/blacklist/file/info?api_key=your-api-key',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Response samples

Content type
application/json
{
  • "count": 10,
  • "offset": 0,
  • "total": 24,
  • "results": [
    ]
}

Download file result

Download the detailed results of a file

query Parameters
api_key
required
string
Example: api_key=your-api-key

The user's API key

file_id
required
string
Example: file_id=16163983962328dj5HoZq0DievB7

The ID of the file

Responses

Request samples 

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'api.emailacademy.com/v1/blacklist/file/download-result?api_key=your-api-key&file_id=16163983962328dj5HoZq0DievB7',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Response samples

Content type
application/json
application/json
application/octet-stream
{
  • "result": "error",
  • "error": "File not found"
}

Email Verifier

Email verifier

Verify a file

Upload a file of email addresses for verification

Request Body schema: multipart/form-data

Request parameters for uploading a file

file
required
any <binary>

The file containing the email addresses

api_key
required
string

The user's API key

Responses

Request samples 

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'api.emailacademy.com/v1/email-verifier/file/verify',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => array('api_key' => 'your-api-key','file'=> new CURLFILE('/path/to/file')),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Response samples

Content type
application/json
{
  • "file_id": 25,
  • "error": "",
  • "total_rows": 5,
  • "unique_emails": 3
}

Verify a list

Verify a list of emails

Request Body schema: application/json

Request parameters for list email verification

api_key
required
string

The user's API key

emails
required
Array of strings

Array of email addresses

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "file_id": 2,
  • "error": "",
  • "total_rows": 5,
  • "unique_emails": 5
}

Download results

Download the results of email verification

query Parameters
api_key
required
string
Example: api_key=your-api-key

The user's API key

file_id
required
string
Example: file_id=2

File ID

report_type
string
Enum: "good" "risky" "bad" ""
Example: report_type=

Report type. If omitted or empty string given, then all results will be downloaded

Responses

Request samples 

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'api.emailacademy.com/v1/email-verifier/file/download-result?api_key=your-api-key&file_id=111',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Response samples

Content type
application/json
application/json
application/octet-stream
{
  • "result": "error",
  • "error": "File not found"
}

File info

Get a list of file information

query Parameters
api_key
required
string
Example: api_key=your-api-key

The user's API key

file_id
string
Example: file_id=20

Optional file ID filter

count
string
Example: count=10

Optional count filter as to how much files to retrieve for pagination

offset
string
Example: offset=0

Optional offset filter for pagination

file_name
string
Example: file_name=filename.txt

Optional file name filter

Responses

Request samples 

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'api.emailacademy.com/v1/email-verifier/file/info?api_key=your-api-key&file_id=20',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Response samples

Content type
application/json
{
  • "count": 0,
  • "offset": 0,
  • "total": 0,
  • "results": [
    ]
}

Verify an email address

Verify an email address

query Parameters
api_key
required
string
Example: api_key=your-api-key

The user's API key

email
required
string

The email to verify

Responses

Request samples 

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'api.emailacademy.com/v1/email-verifier-single?api_key=your-api-key&[email protected]',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Response samples

Content type
application/json
{}

Bounce Code Analyzer

Bounce Code Analyzer

Analyze a file

Upload a file of bounce codes for analyzation

Request Body schema: multipart/form-data

Request parameters for uploading a file

file
required
any <binary>

The file containing the bounce codes

api_key
required
string

The user's API key

Responses

Request samples 

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'api.emailacademy.com/v1/bounce-code-analyzer/file/analyze',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => array('api_key' => 'your-api-key','file'=> new CURLFILE('/path/to/file')),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Response samples

Content type
application/json
{
  • "file_id": "1628750661SHYNuWITqYoeWc"
}

Get file information

Get a list of files with detailed information of the files

query Parameters
api_key
required
string
Example: api_key=your-api-key

The user's API key

offset
string
Example: offset=5

Optional offset for pagination. Defaults to 0

count
string
Example: count=15

Optional count for pagination. Defaults to 10

file_id
string
Example: file_id=1628750661SHYNuWITqYoeWc

Optional file ID filter. Exact file ID must be given.

file_name
string
Example: file_name=bounce

Optional file name filter. The given string will be looked up in the file name.

Responses

Request samples 

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'api.emailacademy.com/v1/bounce-code-analyzer/file/info?api_key=your-api-key',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Response samples

Content type
application/json
{
  • "count": 10,
  • "offset": 0,
  • "total": 24,
  • "results": [
    ]
}

Download file result

Download the detailed results of a file

query Parameters
api_key
required
string
Example: api_key=your-api-key

The user's API key

file_id
required
string
Example: file_id=16163983962328dj5HoZq0DievB7

The ID of the file

Responses

Request samples 

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'api.emailacademy.com/v1/bounce-code-analyzer/file/download-result?api_key=your-api-key&file_id=16163983962328dj5HoZq0DievB7',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Response samples

Content type
application/json
application/json
application/octet-stream
{
  • "result": "error",
  • "error": "File not found"
}

Analyze a bounce code

Analyze a bounce code

query Parameters
api_key
required
string
Example: api_key=your-api-key

The user's API key

bounce_code
required
string
Example: bounce_code=550

The bounce code

Responses

Request samples 

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'http://api.emailacademy.com/v1/bounce-code-analyzer?api_key=aAyNqDyJIKgj2zyPq2qqL&bounce_code=550',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "denied"
}

Analyze a bounce code

Analyze a bounce code

Request Body schema: application/json

Request parameters for bounce code analyzer

bounce_code
required
string

The bounce code

api_key
required
string

The user's API key

Responses

Request samples

Content type
application/json
{
  • "api_key": "your-api-key",
  • "bounce_code": "554 Message not allowed"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "denied"
}

Analyze bounce codes

Analyze multiple bounce codes

Request Body schema: application/json

Request parameters for bounce code analyzer

bounce_code
required
Array of strings

The array of bounce codes

api_key
required
string

The user's API key

Responses

Request samples

Content type
application/json
{
  • "api_key": "your-api-key",
  • "bounce_code": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "message": [
    ]
}

RDNS Tester

RDNS Tester

RNDS Tester

Enter IP address to do a reverse DNS (rDNS) lookup.

query Parameters
api_key
required
string
Example: api_key=your-api-key

The user's API key

domain
required
string
Example: domain=172.217.20.14

IP address

Responses

Request samples 

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'api.emailacademy.com/v1/rdns?api_key=your-api-key&ip_address=79.172.213.243',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Response samples

Content type
application/json
{
  • "success": false,
  • "hostnames": [ ]
}

RNDS Tester

Enter IP address to do a reverse DNS (rDNS) lookup.

Request Body schema: application/json

Request parameters for RDNS Tester

ip_address
required
string

The IP address

api_key
required
string

The user's API key

Responses

Request samples

Content type
application/json
{
  • "api_key": "your-api-key",
  • "ip_address": "172.217.20.14"
}

Response samples

Content type
application/json
{
  • "success": false,
  • "hostnames": [ ]
}

SPF & DKIM Tester

SPF & DKIM Tester

SPF & DKIM tester

Check if your domain has these email signatures set up and if they are valid

query Parameters
api_key
required
string
Example: api_key=your-api-key

The user's API key

domain
required
string
Example: domain=mail.fishngo.net

The domain

dkim_selector
required
string
Example: dkim_selector=krs._domainkey

DKIM selector

Responses

Request samples 

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'api.emailacademy.com/v1/spf-dkim?api_key=your-api-key&domain=mail.fishngo.net&dkim_selector=krs._domainkey',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Response samples

Content type
application/json
{
  • "success": false,
  • "spf_records": [
    ],
  • "dkim_records": [
    ],
  • "dmarc_records": [ ],
  • "error_message": "No DMARC record found for _dmarc.mail.fishngo.net"
}

SPF & DKIM tester

Check if your domain has these email signatures set up and if they are valid

Request Body schema: application/json

Request parameters for SPF & DKIM Tester

domain
required
string

The domain

dkim_selector
required
string

DKIM selector

api_key
required
string

The user's API key

Responses

Request samples

Content type
application/json
{
  • "api_key": "your-api-key",
  • "domain": "mail.fishngo.net",
  • "dkim_selector": "krs._domainkey"
}

Response samples

Content type
application/json
{
  • "success": false,
  • "spf_records": [
    ],
  • "dkim_records": [
    ],
  • "dmarc_records": [ ],
  • "error_message": "No DMARC record found for _dmarc.mail.fishngo.net"
}

Blacklist Monitor

Blacklist Monitor

Get the settings of Blacklist Monitor

Get the current settings of Blacklist Monitor

query Parameters
api_key
required
string
Example: api_key=your-api-key

The user's API key

Responses

Request samples 

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'api.emailacademy.com/v1/blacklist-monitor/settings?api_key=your-api-key',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Response samples

Content type
application/json
{
  • "is_active": 1,
  • "email": "[email protected]",
  • "phone": "+12345678912",
  • "webhook_url": "",
  • "updated_at": "2021-08-06T09:50:51Z"
}

Update the settings of Blacklist Monitor

Update various settings of Blacklist Monitor

Request Body schema: application/json

Request parameters for updating the settings of Blacklist Monitor. All parameters must be present, blank values will be treated as is, updating the current settings with blank values.

api_key
required
string

The user's API key

is_active
required
boolean

Whether to set Blacklist Monitor to active or inactive

email
required
string

The email address where notifications will be sent

phone
required
string

The phone number where notifications will be sent. E.164 formatting is required.

webhook_url
required
string

The webhook url where notifications will be sent.

Responses

Request samples

Content type
application/json
{
  • "api_key": "your-api-key",
  • "is_active": true,
  • "email": "[email protected]",
  • "phone": "+12345678912",
  • "webhook_url": ""
}

Response samples

Content type
application/json
{
  • "rows_affected": 1
}

Update notification settings for domain or IP address

Update the notification settings for a single domain or IP address

Request Body schema: application/json

Request parameters for updating the notification settings of a single domain or IP address. All parameters must be present, notification setting values left blank treated as 0.

api_key
required
string

The user's API key

id
required
integer

ID of the domain or IP address

notification_email
required
integer

Turn on/off email notification for domain or IP address

notification_sms
required
integer

Turn on/off sms notification for domain or IP address

notification_webhook
required
integer

Turn on/off webhook notification for domain or IP address

Responses

Request samples

Content type
application/json
{
  • "api_key": "your-api-key",
  • "id": 2,
  • "notification_email": 1,
  • "notification_sms": 1,
  • "notification_webhook": 0
}

Response samples

Content type
application/json
Example
BlacklistMonitorSettingUpdateResponse
BlacklistMonitorSettingUpdateResponse
BlacklistMonitorWebhookExample
{
  • "rows_affected": 1
}

Delete domains or IP addresses

Delete domains or IP addresses from the Blacklist Monitor

Request Body schema: application/json

Request parameters for deleting domains or IP addresses from Blacklist Monitor

api_key
required
string

The user's API key

ids
required
Array of strings

IDs of the Domains or IP addresses to delete

Responses

Request samples

Content type
application/json
{
  • "api_key": "your-api-key",
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "rows_affected": 2
}

Add domains or IP addresses

Add domains or IP addresses to the Blacklist Monitor

Request Body schema: application/json

Request parameters for adding domains or IP addresses to Blacklist Monitor

api_key
required
string

The user's API key

domains
required
Array of strings

Domains or IP addresses to add

Responses

Request samples

Content type
application/json
{
  • "api_key": "your-api-key",
  • "domains": [
    ]
}

Response samples

Content type
application/json
{
  • "rows_affected": 2
}

Get Blacklist Monitor domain

Get the details of a Blacklist Monitor domain

query Parameters
api_key
required
string
Example: api_key=your-api-key

The user's API key

domain
required
string
Example: domain=example.com

Domain or IP address

Responses

Request samples 

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'api.emailacademy.com/v1/blacklist-monitor/domain?api_key=your-api-key&domain=example.com',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Response samples

Content type
application/json
{
  • "id": 1,
  • "user_id": 1,
  • "domain": "example.com",
  • "notification_email": "[email protected]",
  • "notification_sms": "+12345678912",
  • "notification_webhook": "https://example.com/webhook",
  • "currently_blacklisted": 0,
  • "created_at": "2021-01-01 01:04:02",
  • "updated_at": "2021-01-02 15:04:05"
}

Get Blacklist Monitor domains

Get a detailed list of Blacklist Monitor domains

query Parameters
api_key
required
string
Example: api_key=your-api-key

The user's API key

Responses

Request samples 

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'api.emailacademy.com/v1/blacklist-monitor/domains?api_key=your-api-key',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Website Monitor

Get the settings of Website Monitor

Get the current settings of Website Monitor

query Parameters
api_key
required
string
Example: api_key=your-api-key

The user's API key

Responses

Request samples 

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'api.emailacademy.com/v1/website-monitor/settings?api_key=your-api-key',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Response samples

Content type
application/json
{
  • "is_active": 1,
  • "email": "[email protected]",
  • "phone": "+12345678912",
  • "webhook_url": "",
  • "updated_at": "2021-08-06T09:50:51Z"
}

Update the settings of Website Monitor

Update various settings of Website Monitor

Request Body schema: application/json

Request parameters for updating the settings of Website Monitor. All parameters must be present, blank values will be treated as is, updating the current settings with blank values.

api_key
required
string

The user's API key

is_active
required
boolean

Whether to set Website Monitor to active or inactive

email
required
string

The email address where notifications will be sent

phone
required
string

The phone number where notifications will be sent. E.164 formatting is required.

webhook_url
required
string

The webhook url where notifications will be sent.

Responses

Request samples

Content type
application/json
{
  • "api_key": "your-api-key",
  • "is_active": true,
  • "email": "[email protected]",
  • "phone": "+12345678912",
  • "webhook_url": ""
}

Response samples

Content type
application/json
{
  • "rows_affected": 1
}

Update notification settings for domain

Update the notification settings for a single domain

Request Body schema: application/json

Request parameters for updating the notification settings of a single domain. All parameters must be present, notification setting values left blank treated as 0.

api_key
required
string

The user's API key

id
required
integer

ID of the domain

notification_email
required
integer

Turn on/off email notification for domain

notification_sms
required
integer

Turn on/off sms notification for domain

notification_webhook
required
integer

Turn on/off webhook notification for domain

Responses

Request samples

Content type
application/json
{
  • "api_key": "your-api-key",
  • "id": 2,
  • "notification_email": 1,
  • "notification_sms": 1,
  • "notification_webhook": 0
}

Response samples

Content type
application/json
Example
WebsiteMonitorSettingUpdateResponse
WebsiteMonitorSettingUpdateResponse
WebsiteMonitorWebhookExample
{
  • "rows_affected": 1
}

Delete domains

Delete domains from the Website Monitor

Request Body schema: application/json

Request parameters for deleting domains from Website Monitor

api_key
required
string

The user's API key

ids
required
Array of strings

IDs of the Domains to delete

Responses

Request samples

Content type
application/json
{
  • "api_key": "your-api-key",
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "rows_affected": 2
}

Add domains

Add domains to the Website Monitor

Request Body schema: application/json

Request parameters for adding domains to Website Monitor

api_key
required
string

The user's API key

domains
required
Array of strings

Domains to add

Responses

Request samples

Content type
application/json
{
  • "api_key": "your-api-key",
  • "domains": [
    ]
}

Response samples

Content type
application/json
{
  • "rows_affected": 2
}

Get Website Monitor domain

Get the details of a Website Monitor domain

query Parameters
api_key
required
string
Example: api_key=your-api-key

The user's API key

domain
required
string
Example: domain=example.com

Domain

Responses

Request samples 

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'api.emailacademy.com/v1/website-monitor/domain?api_key=your-api-key&domain=example.com',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Response samples

Content type
application/json
{
  • "id": 1,
  • "user_id": 1,
  • "domain": "example.com",
  • "notification_email": "[email protected]",
  • "notification_sms": "+12345678912",
  • "notification_webhook": "https://example.com/webhook",
  • "currently_down": 0,
  • "created_at": "2021-01-01 01:04:02",
  • "updated_at": "2021-01-02 15:04:05"
}

Get Website Monitor domains

Get a detailed list of Website Monitor domains

query Parameters
api_key
required
string
Example: api_key=your-api-key

The user's API key

Responses

Request samples 

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'api.emailacademy.com/v1/website-monitor/domains?api_key=your-api-key',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Inbox tester

Generate an email for the inbox tester

Generate an email for the inbox tester

query Parameters
api_key
required
string
Example: api_key=your-api-key

The user's API key

Responses

Request samples 

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'api.emailacademy.com/v1/inbox-tester/get-email?api_key=your-api-key',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Response samples

Content type
application/json
{}

Inbox tester

Inbox tester

query Parameters
api_key
required
string
Example: api_key=your-api-key

The user's API key

email
required
string
Example: email=email

The generated email

Responses

Request samples 

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'api.emailacademy.com/v1/inbox-tester?api_key=your-api-key&email=email',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Response samples

Content type
application/json
{}