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/rules/{id}

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "name": "string",
  "metric": "dnsbl_listed",
  "threshold": 0,
  "action": "notify",
  "id": "string",
  "enabled": true
}

Schema

namestringrequired

metricstringrequired

dnsbl_listed | spam_rate | bounce_rate | domain_reputation

thresholdnumberrequired

A fraction, not a percent: spam_rate and bounce_rate fire at or above it (0.003 = 0.3%, the Gmail line; 0.05 = 5% bounces); domain_reputation fires at or below 0 BAD, 1 LOW, 2 MEDIUM; dnsbl_listed ignores it

= 0

actionstringrequired

notify | pause | throttle = notify

idstringrequired

enabledbooleanrequired

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/rules/{id}

DELETEhttps://hermeticor.com/v1/deliverability/rules/{id}

Parameters

idstringpathrequired

Code samples

cURL

curl -X DELETE "https://hermeticor.com/v1/deliverability/rules/{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/rules/{id}

5XX Default Response

Same as 4XX · GET /v1/deliverability/rules/{id}

PATCHhttps://hermeticor.com/v1/deliverability/rules/{id}

Parameters

idstringpathrequired

Request body

application/json

namestring

thresholdnumber

actionstring

notify | pause | throttle

enabledboolean

{
  "name": "string",
  "threshold": 0,
  "action": "notify",
  "enabled": true
}

Code samples

cURL

curl -X PATCH "https://hermeticor.com/v1/deliverability/rules/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","threshold":0,"action":"notify","enabled":true}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · GET /v1/deliverability/rules/{id}

4XX Default Response

Same as 4XX · GET /v1/deliverability/rules/{id}

5XX Default Response

Same as 4XX · GET /v1/deliverability/rules/{id}

GEThttps://hermeticor.com/v1/deliverability/alerts

Parameters

limitintegerquery

Page size; omitted returns the whole list

cursorstringquery

Opaque: the nextCursor of the previous page

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/deliverability/alerts" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "ruleId": "string",
      "domain": "string",
      "metric": "dnsbl_listed",
      "value": "string",
      "action": "notify",
      "status": "open",
      "pausedConnections": [
        "string"
      ],
      "openedAt": "2024-01-01T00:00:00Z",
      "resolvedAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem109[]required

Show child parameters

idstringrequired

ruleIdstringrequired

domainstringrequired

metricstringrequired

dnsbl_listed | spam_rate | bounce_rate | domain_reputation

valuestringrequired

actionstringrequired

notify | pause | throttle

statusstringrequired

open | resolved

pausedConnectionsstring[]required

openedAtstringrequired

resolvedAtstringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · GET /v1/deliverability/rules/{id}

5XX Default Response

Same as 4XX · GET /v1/deliverability/rules/{id}

POSThttps://hermeticor.com/v1/deliverability/alerts/{id}/resolve

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · DELETE /v1/deliverability/rules/{id}

4XX Default Response

Same as 4XX · GET /v1/deliverability/rules/{id}

5XX Default Response

Same as 4XX · GET /v1/deliverability/rules/{id}

GEThttps://hermeticor.com/v1/deliverability/warmup/{connectionId}

Parameters

connectionIdstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "connectionId": "string",
  "status": "off",
  "pausedReason": "string",
  "address": "string",
  "settings": {
    "enabled": true,
    "startPerDay": 2,
    "incrementPerDay": 2,
    "maxPerDay": 30
  },
  "lastError": "string",
  "lastErrorAt": "2024-01-01T00:00:00Z",
  "quotaToday": 0,
  "sentToday": 0,
  "poolSize": 0,
  "score": 0,
  "totals": {
    "sent": 0,
    "bounced": 0,
    "inbox": 0,
    "spam": 0,
    "replies": 0
  },
  "series": [
    {
      "day": "string",
      "sent": 0,
      "inbox": 0,
      "spam": 0
    }
  ]
}

Schema

connectionIdstringrequired

statusstringrequired

off | active | paused

pausedReasonstringrequired

addressstringrequired

settingsobjectrequired

Show child parameters

enabledbooleanrequired

startPerDayintegerrequired

= 2

incrementPerDayintegerrequired

= 2

maxPerDayintegerrequired

= 30

lastErrorstringrequired

lastErrorAtstringrequired

quotaTodayintegerrequired

sentTodayintegerrequired

poolSizeintegerrequired

scoreintegerrequired

totalsobjectrequired

Show child parameters

sentintegerrequired

bouncedintegerrequired

inboxintegerrequired

spamintegerrequired

repliesintegerrequired

seriesSeriesItem[]required

Show child parameters

daystringrequired

sentintegerrequired

inboxintegerrequired

spamintegerrequired

4XX Default Response

Same as 4XX · GET /v1/deliverability/rules/{id}

5XX Default Response

Same as 4XX · GET /v1/deliverability/rules/{id}

PUThttps://hermeticor.com/v1/deliverability/warmup/{connectionId}

Parameters

connectionIdstringpathrequired

Request body

application/json

enabledbooleanrequired

startPerDayinteger

= 2

incrementPerDayinteger

= 2

maxPerDayinteger

= 30

{
  "enabled": true,
  "startPerDay": 2,
  "incrementPerDay": 2,
  "maxPerDay": 30
}

Code samples

cURL

curl -X PUT "https://hermeticor.com/v1/deliverability/warmup/{connectionId}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"enabled":true,"startPerDay":2,"incrementPerDay":2,"maxPerDay":30}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · GET /v1/deliverability/warmup/{connectionId}

4XX Default Response

Same as 4XX · GET /v1/deliverability/rules/{id}

5XX Default Response

Same as 4XX · GET /v1/deliverability/rules/{id}

GEThttps://hermeticor.com/v1/deliverability/seeds

Parameters

limitintegerquery

Page size; omitted returns the whole list

cursorstringquery

Opaque: the nextCursor of the previous page

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/deliverability/seeds" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "connectionId": "string",
      "address": "string"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem110[]required

Show child parameters

idstringrequired

connectionIdstringrequired

addressstringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · GET /v1/deliverability/rules/{id}

5XX Default Response

Same as 4XX · GET /v1/deliverability/rules/{id}

POSThttps://hermeticor.com/v1/deliverability/seeds

Request body

application/json

connectionIdstringrequired

{
  "connectionId": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/deliverability/seeds" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"connectionId":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "id": "string",
  "connectionId": "string",
  "address": "string"
}

Schema

idstringrequired

connectionIdstringrequired

addressstringrequired

4XX Default Response

Same as 4XX · GET /v1/deliverability/rules/{id}

5XX Default Response

Same as 4XX · GET /v1/deliverability/rules/{id}

Next part

Updated Nov 8, 2026

Was this page helpful?