Get Clients

This call returns a list of our currently active spam clients with some information about them.

Example Response:

[
  {
    "client": "SPAM CLIENT 1",
    "type": "b2c",
    "description": "SPAM CLIENT DESCRIPTION"
  },
  {
    "client": "SPAM CLIENT 2",
    "type": "b2b",
    "description": "SPAM CLIENT DESCRIPTION"
  }
]

Create Spam Test

This call creates a new spam test and submits it to our system for processing.

All requests must contain a subject property and one source property (either html or url). Customers on a user-based reseller package must provide the customer_id as well. All other properties are optional. In the following table, each property and its default value is shown.

The test_method property determines the method we use to run your spam test. There are three options described here in order of accuracy.

Seed List Testing

We will provide you with a list of addresses and you will send your email through your preferred ESP or application to all of the addresses. The accuracy of this method depends on how similar your test send is to your production send.

SMTP Testing

SMTP testing works by providing us with credentials to your SMTP server that we then use to send the email. Because the sending method will differ, we cannot be certain that production results will look identical. Depending on the settings of your domain, this can result in both false negatives and false positives.

EOA Testing

Email on Acid will send the email from our servers and check the spam results. This will check for email content, subject line, and sender email address performance.

Example Request Body:

{
  "subject": "My Email Subject",
  "html": "My HTML",
  "transfer_encoding": "8bit",
  "charset": "utf-8",
  "reference_id": "123ABC",
  "customer_id": "1",
  "test_method": "seed",
  "from_address": "my.test@example.com"
}

Example Response:

{
  "id": "<UNIQUE ID>",
  "reference_id": "123ABC",
  "customer_id": "1",
  "address_list": [
    "spam_address1@example.com",
    "spam_address2@example.com"
  ]
}

Request Details

Get Tests

This call returns a list of all available Spam Tests and some metadata about them. Spam Tests are stored for 90 days.

Example Response:

[
  {
    "id": "<test_id>",
    "date": 1713295149,
    "type": "email-test",
    "headers": {
        "X-EXAMPLE": "My Header"
    }
  },
  {
    "id": "<test_id>",
    "date": 1713295149,
    "type": "spam-test",
    "headers": {}
  }
]

Search Tests

This call returns a list of Spam Tests that match the criteria in the query string and some metadata about them. Its structure is identical to the above call.

The query string is a standard URL parameterized version containing any or all of the following parameters.

Query String Details

Get Results

This call returns an object containing the status of your spam result.

Example Response:

[
  {
    "client": "SPAM CLIENT 1",
    "type": "b2c",
    "spam": 1,
    "details": "SPAM DETAILS"
  },
  {
    "client": "SPAM CLIENT 2",
    "type": "b2b",
    "spam": -1,
    "details": ""
  }
]

Response Details

Delete Test

This call marks a Spam Test as deleted. Once it is deleted, it cannot be recovered.

Example Response:

{
  "success": true
}

Get Seed List

This call returns a list of email addresses to send to for your seed list type spam test. If your spam test was not a seed list type, you will receive an error.

Example Response:

[
  "address1@example.com",
  "address2@example.com"
]

Reserve Seed List

This call reserves a list of email addresses to send to for your seed list type spam test. This call is only necessary if you need to have the seed list prior to test creation. The key value must be provided when you create a Spam Test or Email Test with spam included, in order to override the system-generated value.

Example Response:

{
    "key": "EXAMPLE",
    "address_list": [
        "EXAMPLE@spc.emailonacid.com",
        "cloudmark+EXAMPLE@cm.emailonacid.com",
    ]
}