v1

latestOpenAPI 3.1.02026-07-2670105729.6 KB
Emails

Accessibility audit

Audit the email’s latest rendered HTML for accessibility issues against WCAG 2.1 (missing alt text, non-descriptive links, low text contrast, tiny fonts, missing lang, empty headings). Returns a score (0–100), a summary, and a list of issues with their WCAG criterion. FIXED cost: 5 credits (X-Credit-Cost: 5), charged ONLY on success — if the audit cannot complete in time, the call returns a retryable 503 and is NOT billed.

post/v1/emails/{emailId}/accessibility-audit

Path parameters

emailIdstring required

Design id returned by POST /v1/emails and listed by GET /v1/emails.

Example:eml_2SmZOWV3ZQ7W5x6g3m4p

Design id returned by POST /v1/emails and listed by GET /v1/emails.

Response

The audit result.

scoreinteger required