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

const migma = new Migma('YOUR_API_KEY');

const { data, error } = await migma.validation.deliverability({
  html: '<html>...</html>',
  subject: 'My Email Subject'
});
{
  "success": true,
  "data": {
    "prediction": {
      "category": "inbox",
      "confidence": 123,
      "score": 123,
      "reasoning": "<string>"
    },
    "contentSignals": {
      "promotional": [
        "<string>"
      ],
      "transactional": [
        "<string>"
      ],
      "spam": [
        "<string>"
      ],
      "engagement": [
        "<string>"
      ]
    },
    "spamScore": {
      "score": 123,
      "triggers": [
        "<string>"
      ],
      "recommendations": [
        "<string>"
      ]
    },
    "recommendations": {
      "critical": [
        "<string>"
      ],
      "important": [
        "<string>"
      ],
      "suggested": [
        "<string>"
      ]
    },
    "metadata": {
      "processingTime": 123,
      "analysisType": "<string>"
    }
  }
}

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 analyze

​
subject
string

Email subject line

​
fromName
string

Sender name

​
fromEmail
string<email>

Sender email address

Response

Deliverability analysis completed

​
success
boolean
​
data
object