consent

Embed

<a href="https://hermeticor.com/docs/ref-consent"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/da934e58-dc9c-402a-aa1a-af47ac300ca4/social-card.svg?v=3e7ae33eec8b" alt="consent" width="600" height="315"></a>

POSThttps://hermeticor.com/v1/eligibility/check

Debug: would this send be allowed?

Request body

application/json

profileIdstringrequired

channelstringrequired

email | sms | whatsapp | push | postcard

purposestringrequired

marketing | prospecting | transactional | operational

topicIdstring

destinationstringrequired

recipientCountrystring

{
  "profileId": "string",
  "channel": "email",
  "purpose": "marketing",
  "topicId": "string",
  "destination": "string",
  "recipientCountry": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/eligibility/check" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"profileId":"string","channel":"email","purpose":"marketing","topicId":"string","destination":"string","recipientCountry":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "eligible": true,
  "reasons": [
    "suppressed"
  ]
}

Schema

eligiblebooleanrequired

reasonsstring[]required

4XX Default Response

Example

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

Schema

errorobjectrequired

Show child parameters

codestringrequired

messagestringrequired

detailsobject

5XX Default Response

Same as 4XX · POST /v1/eligibility/check

GEThttps://hermeticor.com/v1/outbound/blocklist

Blocklist entries: domains (covering subdomains) and individual addresses

Parameters

kindstringquery

domain | email

qstringquery

limitintegerquery

= 200

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "kind": "domain",
      "value": "string",
      "reason": "string",
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ]
}

Schema

itemsItemsItem132[]required

Show child parameters

idstringrequired

kindstringrequired

domain | email

valuestringrequired

reasonstringrequired

createdAtstringrequired

4XX Default Response

Same as 4XX · POST /v1/eligibility/check

5XX Default Response

Same as 4XX · POST /v1/eligibility/check

POSThttps://hermeticor.com/v1/outbound/blocklist/bulk

Add many emails and domains at once; an address with an "@" is a do-not-send address, anything else a domain

Request body

application/json

entriesstring[]required

reasonstring

{
  "entries": [
    "string"
  ],
  "reason": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/outbound/blocklist/bulk" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"entries":["string"],"reason":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "added": 0,
  "existing": 0,
  "removed": 0,
  "invalid": [
    {
      "value": "string",
      "error": "string"
    }
  ]
}

Schema

addedintegerrequired

existingintegerrequired

removedintegerrequired

invalidobject[]required

Show child parameters

valuestringrequired

errorstringrequired

4XX Default Response

Same as 4XX · POST /v1/eligibility/check

5XX Default Response

Same as 4XX · POST /v1/eligibility/check

POSThttps://hermeticor.com/v1/outbound/blocklist/import

Import a CSV or pasted list of emails and domains

Request body

application/json

csvstringrequired

reasonstring

{
  "csv": "string",
  "reason": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/outbound/blocklist/import" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"csv":"string","reason":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · POST /v1/outbound/blocklist/bulk

4XX Default Response

Same as 4XX · POST /v1/eligibility/check

5XX Default Response

Same as 4XX · POST /v1/eligibility/check

POSThttps://hermeticor.com/v1/outbound/blocklist/bulk-delete

Remove many blocklist entries by value; suppressions from bounces, complaints and unsubscribes are never lifted here

Request body

application/json

entriesstring[]required

{
  "entries": [
    "string"
  ]
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/outbound/blocklist/bulk-delete" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"entries":["string"]}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · POST /v1/outbound/blocklist/bulk

4XX Default Response

Same as 4XX · POST /v1/eligibility/check

5XX Default Response

Same as 4XX · POST /v1/eligibility/check

GEThttps://hermeticor.com/v1/outbound/blocklist/download

Parameters

kindstringquery

domain | email

qstringquery

limitintegerquery

= 200

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/outbound/blocklist/download" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

{}

4XX Default Response

Same as 4XX · POST /v1/eligibility/check

5XX Default Response

Same as 4XX · POST /v1/eligibility/check

GEThttps://hermeticor.com/v1/outbound/blocklist/{id}

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "id": "string",
  "kind": "domain",
  "value": "string",
  "reason": "string",
  "createdAt": "2024-01-01T00:00:00Z"
}

Schema

idstringrequired

kindstringrequired

domain | email

valuestringrequired

reasonstringrequired

createdAtstringrequired

4XX Default Response

Same as 4XX · POST /v1/eligibility/check

5XX Default Response

Same as 4XX · POST /v1/eligibility/check

PATCHhttps://hermeticor.com/v1/outbound/blocklist/{id}

Edit the note of one blocklist entry

Parameters

idstringpathrequired

Request body

application/json

reasonstringrequired

{
  "reason": "string"
}

Code samples

cURL

curl -X PATCH "https://hermeticor.com/v1/outbound/blocklist/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"reason":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · GET /v1/outbound/blocklist/{id}

4XX Default Response

Same as 4XX · POST /v1/eligibility/check

5XX Default Response

Same as 4XX · POST /v1/eligibility/check

GEThttps://hermeticor.com/v1/consent/lookup

Consent state and active suppressions for an email address or phone number

Parameters

emailstringquery

phonestringquery

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "profileId": "string",
  "items": [
    {
      "profileId": "string",
      "channel": "email",
      "purpose": "marketing",
      "topicId": "string",
      "status": "granted",
      "recordId": "string",
      "expiresAt": "2024-01-01T00:00:00Z",
      "updatedAt": "2024-01-01T00:00:00Z"
    }
  ],
  "suppressions": [
    {
      "channel": "email",
      "scope": "string",
      "reason": "string"
    }
  ]
}

Schema

profileIdstringrequired

itemsItemsItem16[]required

Show child parameters

profileIdstringrequired

channelstringrequired

email | sms | whatsapp | push | postcard

purposestringrequired

marketing | prospecting | transactional | operational

topicIdstringrequired

statusstringrequired

granted | revoked | pending_confirmation

recordIdstringrequired

expiresAtstringrequired

updatedAtstringrequired

suppressionsobject[]required

Show child parameters

channelstringrequired

email | sms | whatsapp | push | postcard

scopestringrequired

reasonstringrequired

4XX Default Response

Same as 4XX · POST /v1/eligibility/check

5XX Default Response

Same as 4XX · POST /v1/eligibility/check

POSThttps://hermeticor.com/v1/profiles/{id}/preference-link

Mint a signed link to the hosted preference page (/p/...) for this profile

Parameters

idstringpathrequired

Request body

application/json

channelstring

email | sms | whatsapp | push | postcard = email

topicIdstring

{
  "channel": "email",
  "topicId": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/profiles/{id}/preference-link" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"channel":"email","topicId":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "url": "string"
}

Schema

urlstringrequired

4XX Default Response

Same as 4XX · POST /v1/eligibility/check

5XX Default Response

Same as 4XX · POST /v1/eligibility/check

Next part

Updated Nov 8, 2026

Was this page helpful?