deliverability

Embed
Preview of the card
<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>
DELETEhttps://hermeticor.com/v1/deliverability/seeds/{id}

Parameters

idstringpathrequired

Code samples

cURL
curl -X DELETE "https://hermeticor.com/v1/deliverability/seeds/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "ok": true
}
Schema
okbooleanrequired
true
4XX Default Response
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
detailsobject
5XX Default Response

Same as 4XX · DELETE /v1/deliverability/seeds/{id}

GEThttps://hermeticor.com/v1/deliverability/placement-tests

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/placement-tests" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "items": [
    {
      "id": "string",
      "senderAddress": "string",
      "status": "running",
      "createdAt": "2024-01-01T00:00:00Z",
      "completedAt": "2024-01-01T00:00:00Z",
      "name": "string",
      "folder": "string",
      "recurEveryDays": 0,
      "nextRunAt": "2024-01-01T00:00:00Z",
      "results": [
        {
          "seedAddress": "string",
          "folder": "inbox"
        }
      ]
    }
  ],
  "nextCursor": "string"
}
Schema
itemsItemsItem111[]required
Show child parameters
idstringrequired
senderAddressstringrequired
statusstringrequired
running | done | stopped
createdAtstringrequired
completedAtstringrequired
namestring
folderstring
recurEveryDaysinteger
nextRunAtstring
resultsResultsItem2[]required
Show child parameters
seedAddressstringrequired
folderstringrequired
inbox | spam | missing
nextCursorstringrequired
4XX Default Response

Same as 4XX · DELETE /v1/deliverability/seeds/{id}

5XX Default Response

Same as 4XX · DELETE /v1/deliverability/seeds/{id}

POSThttps://hermeticor.com/v1/deliverability/placement-tests

Request body

application/json
senderConnectionIdstringrequired
namestring
folderstring
subjectstring
bodystring
recurEveryDaysinteger
{
  "senderConnectionId": "string",
  "name": "string",
  "folder": "string",
  "subject": "string",
  "body": "string",
  "recurEveryDays": 0
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/deliverability/placement-tests" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"senderConnectionId":"string","name":"string","folder":"string","subject":"string","body":"string","recurEveryDays":0}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

201 Default Response
Example
{
  "id": "string",
  "senderAddress": "string",
  "status": "running",
  "createdAt": "2024-01-01T00:00:00Z",
  "completedAt": "2024-01-01T00:00:00Z",
  "name": "string",
  "folder": "string",
  "recurEveryDays": 0,
  "nextRunAt": "2024-01-01T00:00:00Z",
  "results": [
    {
      "seedAddress": "string",
      "folder": "inbox"
    }
  ]
}
Schema
idstringrequired
senderAddressstringrequired
statusstringrequired
running | done | stopped
createdAtstringrequired
completedAtstringrequired
namestring
folderstring
recurEveryDaysinteger
nextRunAtstring
resultsResultsItem2[]required
Show child parameters
seedAddressstringrequired
folderstringrequired
inbox | spam | missing
4XX Default Response

Same as 4XX · DELETE /v1/deliverability/seeds/{id}

5XX Default Response

Same as 4XX · DELETE /v1/deliverability/seeds/{id}

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

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/channels" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "items": [
    {
      "id": "string",
      "kind": "email",
      "name": "string",
      "enabled": true
    }
  ],
  "nextCursor": "string"
}
Schema
itemsItemsItem112[]required
Show child parameters
idstringrequired
kindstringrequired
email | slack | discord | webhook
namestringrequired
enabledbooleanrequired
nextCursorstringrequired
4XX Default Response

Same as 4XX · DELETE /v1/deliverability/seeds/{id}

5XX Default Response

Same as 4XX · DELETE /v1/deliverability/seeds/{id}

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

Request body

application/json
kindstringrequired
email | slack | discord | webhook
namestringrequired
targetstringrequired
secretstring
{
  "kind": "email",
  "name": "string",
  "target": "string",
  "secret": "string"
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/deliverability/channels" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"kind":"email","name":"string","target":"string","secret":"string"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

201 Default Response
Example
{
  "id": "string",
  "kind": "email",
  "name": "string",
  "enabled": true
}
Schema
idstringrequired
kindstringrequired
email | slack | discord | webhook
namestringrequired
enabledbooleanrequired
4XX Default Response

Same as 4XX · DELETE /v1/deliverability/seeds/{id}

5XX Default Response

Same as 4XX · DELETE /v1/deliverability/seeds/{id}

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

Parameters

idstringpathrequired

Code samples

cURL
curl -X DELETE "https://hermeticor.com/v1/deliverability/channels/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

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

4XX Default Response

Same as 4XX · DELETE /v1/deliverability/seeds/{id}

5XX Default Response

Same as 4XX · DELETE /v1/deliverability/seeds/{id}

GEThttps://hermeticor.com/v1/deliverability/domain-standards

Parameters

domainstringqueryrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/deliverability/domain-standards?domain=<domain>" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "domain": "string",
  "bimi": {
    "ok": true,
    "record": "string",
    "detail": "string"
  },
  "mtaSts": {
    "ok": true,
    "record": "string",
    "detail": "string",
    "mode": "string"
  },
  "tlsRpt": {
    "ok": true,
    "record": "string",
    "detail": "string"
  }
}
Schema
domainstringrequired
bimiobjectrequired
Show child parameters
okbooleanrequired
recordstring
detailstring
mtaStsobjectrequired
Show child parameters
okbooleanrequired
recordstring
detailstring
modestring
tlsRptobjectrequired
Show child parameters
okbooleanrequired
recordstring
detailstring
4XX Default Response

Same as 4XX · DELETE /v1/deliverability/seeds/{id}

5XX Default Response

Same as 4XX · DELETE /v1/deliverability/seeds/{id}

Updated