Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Email on Acid Email Testing API

Create and manage email rendering tests

Email on Acid Email Testing API is one of 4 APIs that Email on Acid publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Email Testing. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 12 operations across 10 paths, and defines 17 schemas. It is described by OpenAPI 3.0.3, at version 5.0.

Requests are made against a single base URL, https://api.emailonacid.com/v5.

12 operations 10 paths 17 schemas 1 DELETE9 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
5.0
Base URL
https://api.emailonacid.com/v5
Authentication
HTTP Basic
Resource Areas
1

Authentication & Security 1

Email on Acid Email Testing API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • basicAuth — HTTP Basic Authentication using : base64-encoded. Use "sandbox:sandbox" credentials for sandbox testing.

Paths & Operations 12

Across 10 paths, the API surfaces 12 operations — 1 DELETE, 9 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Email Testing 12

Create and manage email rendering tests

GET
/email/tests
Get all email tests
getEmailTests 5 params → 200401
POST
/email/tests
Create email test
createEmailTest body → 200400401403
GET
/email/tests/{testId}
Get email test info
getEmailTest 1 param → 200401404
DELETE
/email/tests/{testId}
Delete email test
deleteEmailTest 1 param → 200401404
GET
/email/tests/{testId}/results
Get all test results
getEmailTestResults 1 param → 200401404
GET
/email/tests/{testId}/results/{clientId}
Get single client test result
getEmailTestResultByClient 2 params → 200401404
PUT
/email/tests/{testId}/results/reprocess
Reprocess screenshots
reprocessScreenshots 1 param body → 200400401404
GET
/email/tests/{testId}/content
Get test HTML content
getEmailTestContent 1 param → 200401404
GET
/email/tests/{testId}/content/inlinecss
Get HTML with inlined CSS
getEmailTestContentInlineCss 1 param → 200401404
GET
/email/tests/{testId}/content/textonly
Get plain text content
getEmailTestContentTextOnly 1 param → 200401404
GET
/email/tests/{testId}/spam/results
Get spam results for email test
getEmailTestSpamResults 1 param → 200401404
GET
/email/tests/{testId}/spam/seedlist
Get spam seed list for email test
getEmailTestSpamSeedList 1 param → 200401404

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are CreateEmailTestRequest (13 properties), EmailClientResult (10 properties), SmtpInfo (5 properties), EmailTestInfo (5 properties). Each schema is shown below with its type and property counts.

SpamConfig
object
Spam test configuration embedded in an email test
4 properties
EmailTestInfo
object
5 properties
EmailClientResult
object
10 properties
SuccessResponse
object
1 property
ReprocessResultsMap
object
Map of client ID to reprocess result
CreateEmailTestRequest
object
13 properties 1 required
EmailContent
object
1 property
CreateEmailTestResponse
object
4 properties
EmailTestResultsMap
object
Map of client ID to rendering result
ClientList
object
1 property
TestSummary
object
4 properties
ReprocessResult
object
3 properties
SpamResult
object
4 properties
ErrorResponse
object
1 property
SmtpInfo
object
SMTP configuration for smtp test method
5 properties 1 required
ScreenshotUrls
object
2 properties
StatusDetails
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

email-on-acid-email-testing-api-openapi.yml Raw ↑

Other APIs Email on Acid publishes across the network.

Email on Acid Authentication API
Email on Acid Email Clients API
Email on Acid Spam Testing API