Link Validation

Email Preview

This API provides functionality to create and manage email preview tests, as well as create shareable links.

Operations

Link Validation

The Link Validation API processes a list of URLs to verify their HTTP status, monitor redirect chains with timing metrics, and provide detailed information on content length, content type, and SSL certificate status.

Operations

Get Link Validation Results

Request

Returns the results of a link validation test.

Security

basicAuth

Path

idstringrequired

The ID of the validation test we want to check the results for

curl -i -X GET \
  -u <username>:<password> \
  'https://api.mailgun.net/v1/inspect/links/{id}'

Responses

A 200 response

Bodyapplication/json

metaobject

itemsobject(github.com-mailgun-inspect-internal-linkvalidation-LinkValidation)

Response

application/json

{
  "meta": {
    "status": "Completed"
  },
  "items": {
    "id": "677eeda04fc661c900945dec",
    "results": [ … ]
  }
}

Reprocess Link Validation Test

Request

Reprocess a link validation test.

Security

basicAuth

Path

idstringrequired

Link Validation Test ID

curl -i -X POST \
  -u <username>:<password> \
  'https://api.mailgun.net/v1/inspect/links/{id}'

Responses

A 200 response

Bodyapplication/json

metaobject

itemsobject(github.com-mailgun-inspect-internal-linkvalidation-CreateResource)

Response

application/json

{
  "meta": {
    "status": "Processing"
  },
  "items": {
    "id": "67803c4b7061304b609e47d0",
    "links": { … }
  }
}

Delete Link Validation Test

Request

Delete a specific link validation test by its unique test ID. This endpoint allows you to remove a link validation test from the system. If the test ID does not exist, the appropriate error message is returned.

Security

basicAuth

Path

idstringrequired

The unique identifier of the test.

curl -i -X DELETE \
  -u <username>:<password> \
  'https://api.mailgun.net/v1/inspect/links/{id}'

Responses

A 200 response

Bodyapplication/json

messagestringrequired

Response

application/json

{
  "message": "Test <id> has been successfully deleted."
}

List Link Validations

Request

Retrieve a list of previous link validation tests based on various filters.

Security

basicAuth

Query

statusstring

Filter by status of the link validation test

idstring

Filter by ID

urlstring

Search by URL

isExpiredSSLstring

Filter by tests that contain expired SSL certificates

statusCodeinteger

Filter by tests with a particular status code

curl -i -X GET \
  -u <username>:<password> \
  'https://api.mailgun.net/v1/inspect/links?status=string&id=string&url=string&isExpiredSSL=string&statusCode=0'

Responses

A 200 response

Bodyapplication/json

metaobject

pagingobject

itemsArray of objects

Response

application/json

{
  "meta": {
    "count": 1
  },
  "paging": {
    "previous": "https://api.mailgun.com/v1/inspect/links?page=eyJzIjowLCJiIjoiNjc4MDNlYzM3MDYxMzA0YjYwOWU0N2Q3IiwicCI6dHJ1ZX0",
    "first": "https://api.mailgun.com/v1/inspect/links?page=eyJzIjowLCJwIjpmYWxzZX0",
    "next": "https://api.mailgun.com/v1/inspect/links?page=eyJzIjowLCJiIjoiNjc4MDNlYzM3MDYxMzA0YjYwOWU0N2Q3IiwicCI6ZmFsc2V9",
    "last": "https://api.mailgun.com/v1/inspect/links?page=eyJzIjowLCJwIjp0cnVlfQ"
  },
  "items": [
    { … }
  ]
}

Create a Link Validation Test

Request

Create a link validation test.

Security

basicAuth

Bodyapplication/jsonrequired

linksArray of strings

linksWithPositionsArray of objects

userAgentstringrequired

curl -i -X POST \
  -u <username>:<password> \
  https://api.mailgun.net/v1/inspect/links \
  -H 'Content-Type: application/json' \
  -d '{
    "links": [
      "string"
    ],
    "linksWithPositions": [
      {
        "url": "string",
        "line": 0,
        "column": 0,
        "selector": "string",
        "absolute_index": 0
      }
    ],
    "userAgent": "string"
  }'

Responses

A 200 response

Bodyapplication/json

metaobject

itemsobject(github.com-mailgun-inspect-internal-linkvalidation-CreateResource)

Response

application/json

{
  "meta": {
    "status": "Processing"
  },
  "items": {
    "id": "67803c4b7061304b609e47d0",
    "links": { … }
  }
}

Create a Link Validation Test

Request

Create a link validation test.

Security

basicAuth

Bodyapplication/jsonrequired

linksArray of strings

linksWithPositionsArray of objects

userAgentstringrequired

curl -i -X POST \
  -u <username>:<password> \
  https://api.mailgun.net/v1/inspect/links/html-validate \
  -H 'Content-Type: application/json' \
  -d '{
    "links": [
      "string"
    ],
    "linksWithPositions": [
      {
        "url": "string",
        "line": 0,
        "column": 0,
        "selector": "string",
        "absolute_index": 0
      }
    ],
    "userAgent": "string"
  }'

Responses

A 200 response

Bodyapplication/json

metaobject

itemsobject(github.com-mailgun-inspect-internal-linkvalidation-CreateResource)

Response

application/json

{
  "meta": {
    "status": "Processing"
  },
  "items": {
    "id": "67803c4b7061304b609e47d0",
    "links": { … }
  }
}

Validates link test results against the provided spreadsheet file

Request

Compares link validation test results to the spreadsheet provided as a CSV, XLS or XLSX file.

Security

basicAuth

Bodymultipart/form-datarequired

string(string)

curl -i -X POST \
  -u <username>:<password> \
  'https://api.mailgun.net/v1/inspect/links/{id}/csv' \
  -H 'Content-Type: multipart/form-data'

Responses

A 200 response

Bodyapplication/json

metaobject

itemsobject(github.com-mailgun-inspect-internal-linkvalidation-CSVValidationResponse)

Response

application/json

{
  "meta": {
    "status": "Complete"
  },
  "items": {
    "errors": [ … ]
  }
}

Image Validation

The Image Validation API processes image URLs or uploads to provide comprehensive details such as dimensions, type, file size, and format, reports frame count, animation duration, color depth, and transparency for GIFs, and include image optimization capabilities.

Operations

Accessibility

The Accessibility API evaluates HTML emails against WCAG standards, providing a clear pass/fail assessment to ensure compliance with accessibility guidelines.

Operations

Email Preview API (1.0.0)

Email Preview

Link Validation

Get Link Validation Results

Request

Responses

Was this helpful?

Reprocess Link Validation Test

Request

Responses

Was this helpful?

Delete Link Validation Test

Request

Responses

Was this helpful?

List Link Validations

Request

Responses

Was this helpful?

Create a Link Validation Test

Request

Responses

Was this helpful?

Create a Link Validation Test

Request

Responses

Was this helpful?

Validates link test results against the provided spreadsheet file

Request

Responses

Was this helpful?

Image Validation

Accessibility

Email Preview API (1.0.0)

Email Preview

Link Validation

Get Link Validation Results

Request

Responses

Was this helpful?

Reprocess Link Validation Test

Request

Responses

Was this helpful?

Delete Link Validation Test

Request

Responses

Was this helpful?

List Link Validations

Request

Responses

Was this helpful?

Create a Link Validation Test

RequestExpand all

Responses

Was this helpful?

Create a Link Validation Test

RequestExpand all

Responses

Was this helpful?

Validates link test results against the provided spreadsheet file

Request

Responses

Was this helpful?

Image Validation

Accessibility

Request

Request