{ "openapi": "3.0.1", "info": { "title": "Cold Email Compliance Check (UK, US, Canada, Germany, France)", "description": "Before you cold email a list, check every address: ok to email, consent needed or blocked. Each answer quotes the rule and its source, says what your footer must include and comes with a signed receipt. Covers UK PECR and GDPR, US CAN-SPAM, Canada's CASL, Germany's UWG and France.", "version": "1.0", "x-build-id": "4BHVQV1RXQZwCRfSG" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/gabe_ao~cold-email-compliance-check/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-gabe_ao-cold-email-compliance-check", "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/gabe_ao~cold-email-compliance-check/runs": { "post": { "operationId": "runs-sync-gabe_ao-cold-email-compliance-check", "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/gabe_ao~cold-email-compliance-check/run-sync": { "post": { "operationId": "run-sync-gabe_ao-cold-email-compliance-check", "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", "properties": { "emails": { "title": "Email addresses", "type": "array", "description": "One address per line. Each address is one check. Duplicates are checked once.", "items": { "type": "string" } }, "senderCountry": { "title": "Where your business is based", "enum": [ "GB", "US" ], "type": "string", "description": "The rules depend on where you send from as well as where the recipient is.", "default": "GB" }, "addressSource": { "title": "Where the addresses came from", "enum": [ "published", "bought", "scraped", "given", "unknown" ], "type": "string", "description": "Some rules treat a bought or scraped list differently from an address the company published itself.", "default": "unknown" }, "pitch": { "title": "What you're offering (optional)", "type": "string", "description": "A few words, such as \"bookkeeping software for small agencies\". It helps where a rule depends on whether the offer is relevant to the recipient's job." }, "defaultRecipientCountry": { "title": "Recipients' country, if they're all in one (optional)", "enum": [ "GB", "US", "CA", "DE", "FR" ], "type": "string", "description": "Used only when the country can't be worked out from the address, company records or the company's website, which mostly matters for .com addresses." }, "leads": { "title": "Leads with details (advanced)", "type": "array", "description": "A list of objects instead of plain addresses, for example [{\"email\": \"jane@acme.co.uk\", \"address_source\": \"published\", \"company_number\": \"01234567\", \"recipient_country\": \"GB\"}]. The settings above fill in anything a lead leaves out." }, "preclearedApiKey": { "title": "Your Precleared API key (optional)", "type": "string", "description": "Paste your key (pc_live_...) and checks come out of your Precleared allowance and packs, so Apify doesn't charge per check. Leave it empty to pay per check through Apify." } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }