API Documentation

In order to use Mailgenius API you need a API token, to get the token please contact [email protected].

Using the api

Before sending the request to Mailgenius endpoints, you need to authorize your HTTP requests. To authorize your HTTP requests you need to send the API token in the Authorization HTTP header with Bearer schema, you can preview the postman example below.

Untitled

(screenshot of HTTP Authorization header)

After sending the HTTP Get request to the /external/api/email-audit endpoint you will get a response which will include special email address to which you can send an email which will be tested by the Mailgenius.

Untitled

(screenshot of getting the email for the test)

After sending an email to the special test_email, In order to preview the test result you need to send the HTTP Get request to the /external/api/email-result/:slug

Note: Keep in mind that you still need to send Authorization HTTP header with your Bearer <api-token>

Note: Testing process is asynchronous so it might take some time until the test result is available.

New Project.png

(screenshot of getting the test results)

To preview all test results send a HTTP Get request to /external/api/audits

You can preview endpoints documentation on app.mailgenius.com/api-docs.

Note: If test record’s used property is false, you can use that test_email to perform a test. The requests limit is calculated based on the number of email addresses you have reserved.