Create Email Preview

Node.js SDK

import Migma from 'migma';

const migma = new Migma('YOUR_API_KEY');

const { data, error } = await migma.previews.create({
  html: '<html>...</html>',
  subject: 'My Email Preview'
});

// Or wait for completion:
// const result = await migma.previews.createAndWait({ ... });

curl --request POST \
  --url https://api.migma.ai/v1/emails/previews \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "html": "<string>",
  "devices": [
    "<string>"
  ],
  "subject": "Email Preview",
  "name": "<string>"
}
'

import requests

url = "https://api.migma.ai/v1/emails/previews"

payload = {
    "html": "<string>",
    "devices": ["<string>"],
    "subject": "Email Preview",
    "name": "<string>"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.migma.ai/v1/emails/previews",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'html' => '<string>',
    'devices' => [
        '<string>'
    ],
    'subject' => 'Email Preview',
    'name' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.migma.ai/v1/emails/previews"

	payload := strings.NewReader("{\n  \"html\": \"<string>\",\n  \"devices\": [\n    \"<string>\"\n  ],\n  \"subject\": \"Email Preview\",\n  \"name\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.migma.ai/v1/emails/previews")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"html\": \"<string>\",\n  \"devices\": [\n    \"<string>\"\n  ],\n  \"subject\": \"Email Preview\",\n  \"name\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.migma.ai/v1/emails/previews")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"html\": \"<string>\",\n  \"devices\": [\n    \"<string>\"\n  ],\n  \"subject\": \"Email Preview\",\n  \"name\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "previewId": "<string>",
    "name": "<string>",
    "subject": "<string>",
    "devices": [
      "<string>"
    ],
    "metadata": {
      "requestedDevices": 123,
      "completedDevices": 123,
      "failedDevices": 123,
      "estimatedCompletionTime": 123
    }
  }
}

{
  "success": false,
  "error": "<string>",
  "code": "<string>",
  "data": {}
}

{
  "success": false,
  "error": "<string>",
  "code": "<string>",
  "data": {}
}

POST

emails

previews

Node.js SDK

import Migma from 'migma';

const migma = new Migma('YOUR_API_KEY');

const { data, error } = await migma.previews.create({
  html: '<html>...</html>',
  subject: 'My Email Preview'
});

// Or wait for completion:
// const result = await migma.previews.createAndWait({ ... });

curl --request POST \
  --url https://api.migma.ai/v1/emails/previews \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "html": "<string>",
  "devices": [
    "<string>"
  ],
  "subject": "Email Preview",
  "name": "<string>"
}
'

import requests

url = "https://api.migma.ai/v1/emails/previews"

payload = {
    "html": "<string>",
    "devices": ["<string>"],
    "subject": "Email Preview",
    "name": "<string>"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.migma.ai/v1/emails/previews",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'html' => '<string>',
    'devices' => [
        '<string>'
    ],
    'subject' => 'Email Preview',
    'name' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.migma.ai/v1/emails/previews"

	payload := strings.NewReader("{\n  \"html\": \"<string>\",\n  \"devices\": [\n    \"<string>\"\n  ],\n  \"subject\": \"Email Preview\",\n  \"name\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.migma.ai/v1/emails/previews")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"html\": \"<string>\",\n  \"devices\": [\n    \"<string>\"\n  ],\n  \"subject\": \"Email Preview\",\n  \"name\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.migma.ai/v1/emails/previews")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"html\": \"<string>\",\n  \"devices\": [\n    \"<string>\"\n  ],\n  \"subject\": \"Email Preview\",\n  \"name\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "previewId": "<string>",
    "name": "<string>",
    "subject": "<string>",
    "devices": [
      "<string>"
    ],
    "metadata": {
      "requestedDevices": 123,
      "completedDevices": 123,
      "failedDevices": 123,
      "estimatedCompletionTime": 123
    }
  }
}

{
  "success": false,
  "error": "<string>",
  "code": "<string>",
  "data": {}
}

{
  "success": false,
  "error": "<string>",
  "code": "<string>",
  "data": {}
}

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 → Developers → API Keys.

Body

application/json

html

string

required

Email HTML content to preview

devices

string[]

required

Specific devices to render on

Minimum array length: 1

subject

string

default:Email Preview

Email subject line (for display purposes)

name

string

Custom name for the preview

Response

Preview creation started

success

boolean

data

object

Show child attributes

Run All Validation Checks Get Preview Status and Results

⌘I

Overview

Developer Tools

Guides

API endpoints

Create Email Preview

Authorizations

Body

Response