deliverability

Embed

<a href="https://hermeticor.com/docs/ref-deliverability"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/cdde641f-86e7-4af2-8e6d-630d445560be/social-card.svg?v=3e7ae33eec8b" alt="deliverability" width="600" height="315"></a>

GEThttps://hermeticor.com/v1/deliverability/placement-tests/{id}

Parameters

idstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/deliverability/placement-tests/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "id": "string",
  "name": "string",
  "folder": "string",
  "senderAddress": "string",
  "status": "running",
  "recurEveryDays": 0,
  "nextRunAt": "2024-01-01T00:00:00Z",
  "parentId": "string",
  "createdAt": "2024-01-01T00:00:00Z",
  "completedAt": "2024-01-01T00:00:00Z",
  "inbox": 0,
  "spam": 0,
  "missing": 0,
  "pending": 0,
  "subject": "string",
  "body": "string",
  "results": [
    {
      "seedAddress": "string",
      "provider": "google",
      "folder": "inbox"
    }
  ],
  "byProvider": [
    {
      "provider": "google",
      "inbox": 0,
      "spam": 0,
      "missing": 0,
      "total": 0,
      "inboxRate": 0
    }
  ],
  "history": [
    {
      "id": "string",
      "name": "string",
      "folder": "string",
      "senderAddress": "string",
      "status": "running",
      "recurEveryDays": 0,
      "nextRunAt": "2024-01-01T00:00:00Z",
      "parentId": "string",
      "createdAt": "2024-01-01T00:00:00Z",
      "completedAt": "2024-01-01T00:00:00Z",
      "inbox": 0,
      "spam": 0,
      "missing": 0,
      "pending": 0
    }
  ],
  "content": {
    "score": 0,
    "threshold": 0,
    "verdict": "pass",
    "rules": [
      {
        "id": "string",
        "points": 0,
        "description": "string"
      }
    ]
  }
}

Schema

idstringrequired

namestringrequired

folderstringrequired

senderAddressstringrequired

statusstringrequired

running | done | stopped

recurEveryDaysintegerrequired

nextRunAtstringrequired

parentIdstringrequired

createdAtstringrequired

completedAtstringrequired

inboxintegerrequired

spamintegerrequired

missingintegerrequired

pendingintegerrequired

subjectstringrequired

bodystringrequired

resultsobject[]required

Show child parameters

seedAddressstringrequired

providerstringrequired

google | microsoft | other

folderstringrequired

inbox | spam | missing

byProviderByProviderItem[]required

Show child parameters

providerstringrequired

google | microsoft | other

inboxintegerrequired

spamintegerrequired

missingintegerrequired

totalintegerrequired

inboxRatenumberrequired

historyobject[]required

Show child parameters

idstringrequired

namestringrequired

folderstringrequired

senderAddressstringrequired

statusstringrequired

running | done | stopped

recurEveryDaysintegerrequired

nextRunAtstringrequired

parentIdstringrequired

createdAtstringrequired

completedAtstringrequired

inboxintegerrequired

spamintegerrequired

missingintegerrequired

pendingintegerrequired

contentobjectrequired

Show child parameters

scorenumberrequired

thresholdnumberrequired

verdictstringrequired

pass | warn | fail

rulesRulesItem5[]required

Show child parameters

idstringrequired

pointsnumberrequired

descriptionstringrequired

4XX Default Response

Example

{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}

Schema

errorobjectrequired

Show child parameters

codestringrequired

messagestringrequired

detailsobject

5XX Default Response

Same as 4XX · GET /v1/deliverability/placement-tests/{id}

DELETEhttps://hermeticor.com/v1/deliverability/placement-tests/{id}

Parameters

idstringpathrequired

Code samples

cURL

curl -X DELETE "https://hermeticor.com/v1/deliverability/placement-tests/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "ok": true
}

Schema

okbooleanrequired

true

4XX Default Response

Same as 4XX · GET /v1/deliverability/placement-tests/{id}

5XX Default Response

Same as 4XX · GET /v1/deliverability/placement-tests/{id}

PATCHhttps://hermeticor.com/v1/deliverability/placement-tests/{id}

Parameters

idstringpathrequired

Request body

application/json

namestring

folderstring

recurEveryDaysinteger

{
  "name": "string",
  "folder": "string",
  "recurEveryDays": 0
}

Code samples

cURL

curl -X PATCH "https://hermeticor.com/v1/deliverability/placement-tests/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","folder":"string","recurEveryDays":0}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · DELETE /v1/deliverability/placement-tests/{id}

4XX Default Response

Same as 4XX · GET /v1/deliverability/placement-tests/{id}

5XX Default Response

Same as 4XX · GET /v1/deliverability/placement-tests/{id}

GEThttps://hermeticor.com/v1/deliverability/placement-tests/{id}/advice

What to fix after a placement test: spam score by section plus DNS, blocklist and provider findings

Parameters

idstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/deliverability/placement-tests/{id}/advice" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "report": {
    "score": 0,
    "threshold": 0,
    "verdict": "pass",
    "engine": "spamassassin",
    "engineNote": "string",
    "fallbackReason": "string",
    "sections": [
      {
        "section": "subject",
        "label": "string",
        "score": 0,
        "rules": [
          {
            "id": "string",
            "points": 0,
            "description": "string",
            "fix": "string"
          }
        ]
      }
    ]
  },
  "advice": [
    {
      "area": "dns",
      "severity": "high",
      "title": "string",
      "detail": "string"
    }
  ]
}

Schema

reportobjectrequired

Show child parameters

scorenumberrequired

thresholdnumberrequired

verdictstringrequired

pass | warn | fail

enginestringrequired

spamassassin | hermetica_rules

engineNotestringrequired

fallbackReasonstringrequired

sectionsSectionsItem[]required

Show child parameters

sectionstringrequired

subject | wording | links | formatting

labelstringrequired

scorenumberrequired

rulesRulesItem6[]required

adviceobject[]required

Show child parameters

areastringrequired

dns | reputation | placement | content

severitystringrequired

high | medium | low

titlestringrequired

detailstringrequired

4XX Default Response

Same as 4XX · GET /v1/deliverability/placement-tests/{id}

5XX Default Response

Same as 4XX · GET /v1/deliverability/placement-tests/{id}

POSThttps://hermeticor.com/v1/deliverability/spam-report

Spam test of a draft: score by section (subject, wording, links, formatting) with a fix per finding. Uses the operator's SpamAssassin (SPAMD_URL) when set, scoring the message as delivery would render and send it, else the in-house rules; `engine` says which

Request body

application/json

subjectstring

textstring

htmlstring

purposestring

marketing | prospecting = prospecting

profileIdstring

connectionIdstring

{
  "subject": "",
  "text": "",
  "html": "string",
  "purpose": "prospecting",
  "profileId": "string",
  "connectionId": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/deliverability/spam-report" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"subject":"","text":"","html":"string","purpose":"prospecting","profileId":"string","connectionId":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "score": 0,
  "threshold": 0,
  "verdict": "pass",
  "engine": "spamassassin",
  "engineNote": "string",
  "fallbackReason": "string",
  "sections": [
    {
      "section": "subject",
      "label": "string",
      "score": 0,
      "rules": [
        {
          "id": "string",
          "points": 0,
          "description": "string",
          "fix": "string"
        }
      ]
    }
  ]
}

Schema

scorenumberrequired

thresholdnumberrequired

verdictstringrequired

pass | warn | fail

enginestringrequired

spamassassin | hermetica_rules

engineNotestringrequired

fallbackReasonstringrequired

sectionsSectionsItem[]required

Show child parameters

sectionstringrequired

subject | wording | links | formatting

labelstringrequired

scorenumberrequired

rulesRulesItem6[]required

Show child parameters

idstringrequired

pointsnumberrequired

descriptionstringrequired

fixstringrequired

4XX Default Response

Same as 4XX · GET /v1/deliverability/placement-tests/{id}

5XX Default Response

Same as 4XX · GET /v1/deliverability/placement-tests/{id}

POSThttps://hermeticor.com/v1/deliverability/placement-tests/{id}/stop

Parameters

idstringpathrequired

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/deliverability/placement-tests/{id}/stop" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · DELETE /v1/deliverability/placement-tests/{id}

4XX Default Response

Same as 4XX · GET /v1/deliverability/placement-tests/{id}

5XX Default Response

Same as 4XX · GET /v1/deliverability/placement-tests/{id}

Next part

Updated Nov 8, 2026

Was this page helpful?