Skip to main content
POST
/
v1
/
emails
/
validate
/
compatibility
Node.js SDK
import Migma from 'migma';

const migma = new Migma('YOUR_API_KEY');

const { data, error } = await migma.validation.compatibility({
  html: '<html>...</html>'
});
{
  "success": true,
  "data": {
    "clientIssues": [
      {
        "client": "<string>",
        "issues": [
          {}
        ],
        "warnings": [
          {}
        ]
      }
    ],
    "summary": {
      "totalErrors": 123,
      "totalWarnings": 123,
      "compatibilityScore": 123
    },
    "supportedClients": [
      "<string>"
    ],
    "metadata": {
      "processingTime": 123,
      "clientsTested": 123
    }
  }
}

Authorizations

​
Authorization
string
header
required

API key authentication. Use 'Authorization: Bearer YOUR_API_KEY' where YOUR_API_KEY is obtained from the Migma dashboard under Settings → API Integration.

Body

application/json
​
html
string
required

Email HTML content to validate

​
clients
string[]

Specific email client IDs to test (optional; defaults to the standard client set)

Response

Compatibility check completed

​
success
boolean
​
data
object