{
"openapi": "3.0.1",
"info": {
"title": "Pre-Send Email HTML Compatibility Checker",
"description": "Check email HTML against 12 client profiles before you send it. Finds Outlook and Gmail breakages, dead or insecure assets, and Gmail clip-limit risk, with no browser and no render farm.",
"version": "0.3",
"x-build-id": "pJ8NI9PvUUUi1trWM"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/kingii98~email-html-compatibility-checker/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-kingii98-email-html-compatibility-checker",
"x-openai-isConsequential": false,
"summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
"tags": [
"Run Actor"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/inputSchema"
}
}
}
},
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "Enter your Apify token here"
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/acts/kingii98~email-html-compatibility-checker/runs": {
"post": {
"operationId": "runs-sync-kingii98-email-html-compatibility-checker",
"x-openai-isConsequential": false,
"summary": "Executes an Actor and returns information about the initiated run in response.",
"tags": [
"Run Actor"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/inputSchema"
}
}
}
},
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "Enter your Apify token here"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/runsResponseSchema"
}
}
}
}
}
}
},
"/acts/kingii98~email-html-compatibility-checker/run-sync": {
"post": {
"operationId": "run-sync-kingii98-email-html-compatibility-checker",
"x-openai-isConsequential": false,
"summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
"tags": [
"Run Actor"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/inputSchema"
}
}
}
},
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "Enter your Apify token here"
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
}
},
"components": {
"schemas": {
"inputSchema": {
"type": "object",
"required": [
"emails"
],
"properties": {
"emails": {
"title": "Email HTML documents",
"minItems": 1,
"maxItems": 200,
"type": "array",
"description": "One or more emails to check. Each item needs a name and one of html (the raw HTML) or htmlUrl (a public URL of the HTML). Maximum 200 items. Maximum 2 MB of HTML for each item. If you leave this field empty, the Actor checks the example email shown below.",
"default": [
{
"name": "spring-sale-email",
"html": ""
}
]
},
"clientProfiles": {
"title": "Client profiles to check",
"minItems": 1,
"maxItems": 12,
"type": "array",
"description": "Email clients to score the HTML against. Defaults to all 12 supported profiles.",
"items": {
"type": "string",
"enum": [
"outlook-desktop-word",
"outlook-com",
"gmail-web",
"gmail-android",
"gmail-ios",
"apple-mail-macos",
"apple-mail-ios",
"yahoo-web",
"aol-web",
"samsung-mail",
"thunderbird",
"orange-fr"
]
},
"default": [
"outlook-desktop-word",
"outlook-com",
"gmail-web",
"gmail-android",
"gmail-ios",
"apple-mail-macos",
"apple-mail-ios",
"yahoo-web",
"aol-web",
"samsung-mail",
"thunderbird",
"orange-fr"
]
},
"checkRemoteAssets": {
"title": "Check remote assets",
"type": "boolean",
"description": "Send one HEAD request for each unique image and link URL that the HTML names. Turn this off to skip all network access.",
"default": true
},
"maxAssetsPerEmail": {
"title": "Maximum assets per email",
"minimum": 0,
"maximum": 200,
"type": "integer",
"description": "Cap on the number of unique remote assets that the Actor checks for each email. Extra assets past this cap are not checked.",
"default": 60
},
"darkModeChecks": {
"title": "Dark mode checks",
"type": "boolean",
"description": "Flag emails that have no color-scheme meta tag and no prefers-color-scheme rule. Clients with a dark mode may auto-invert the colors of such emails.",
"default": true
},
"previousDatasetId": {
"title": "Previous run dataset ID",
"type": "string",
"description": "Optional. Dataset ID from an earlier run of this Actor. When set, each finding is marked as new or already known."
}
}
},
"runsResponseSchema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"actId": {
"type": "string"
},
"userId": {
"type": "string"
},
"startedAt": {
"type": "string",
"format": "date-time",
"example": "2025-01-08T00:00:00.000Z"
},
"finishedAt": {
"type": "string",
"format": "date-time",
"example": "2025-01-08T00:00:00.000Z"
},
"status": {
"type": "string",
"example": "READY"
},
"meta": {
"type": "object",
"properties": {
"origin": {
"type": "string",
"example": "API"
},
"userAgent": {
"type": "string"
}
}
},
"stats": {
"type": "object",
"properties": {
"inputBodyLen": {
"type": "integer",
"example": 2000
},
"rebootCount": {
"type": "integer",
"example": 0
},
"restartCount": {
"type": "integer",
"example": 0
},
"resurrectCount": {
"type": "integer",
"example": 0
},
"computeUnits": {
"type": "integer",
"example": 0
}
}
},
"options": {
"type": "object",
"properties": {
"build": {
"type": "string",
"example": "latest"
},
"timeoutSecs": {
"type": "integer",
"example": 300
},
"memoryMbytes": {
"type": "integer",
"example": 1024
},
"diskMbytes": {
"type": "integer",
"example": 2048
}
}
},
"buildId": {
"type": "string"
},
"defaultKeyValueStoreId": {
"type": "string"
},
"defaultDatasetId": {
"type": "string"
},
"defaultRequestQueueId": {
"type": "string"
},
"buildNumber": {
"type": "string",
"example": "1.0.0"
},
"containerUrl": {
"type": "string"
},
"usage": {
"type": "object",
"properties": {
"ACTOR_COMPUTE_UNITS": {
"type": "integer",
"example": 0
},
"DATASET_READS": {
"type": "integer",
"example": 0
},
"DATASET_WRITES": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_READS": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_WRITES": {
"type": "integer",
"example": 1
},
"KEY_VALUE_STORE_LISTS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_READS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_WRITES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_INTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_EXTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_SERPS": {
"type": "integer",
"example": 0
}
}
},
"usageTotalUsd": {
"type": "number",
"example": 0.00005
},
"usageUsd": {
"type": "object",
"properties": {
"ACTOR_COMPUTE_UNITS": {
"type": "integer",
"example": 0
},
"DATASET_READS": {
"type": "integer",
"example": 0
},
"DATASET_WRITES": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_READS": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_WRITES": {
"type": "number",
"example": 0.00005
},
"KEY_VALUE_STORE_LISTS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_READS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_WRITES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_INTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_EXTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_SERPS": {
"type": "integer",
"example": 0
}
}
}
}
}
}
}
}
}
}![\"Company](\"https://www.w3.org/Icons/w3c_home.png\"){kind=icon}
![](\"https://example.com/does-not-exist.png\")