transactional

Embed

<a href="https://hermeticor.com/docs/ref-transactional"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/3cb76e64-a1f1-4ede-8c35-73d2172e4bf2/social-card.svg?v=3e7ae33eec8b" alt="transactional" width="600" height="315"></a>

GEThttps://hermeticor.com/v1/bounces

Bounce browser: hard/soft bounce events with recipient, filterable by type, recipient domain, connection and date

Parameters

limitintegerquery

= 50

cursorstringquery

typestringquery

hard | soft

domainstringquery

qstringquery

connectionIdstringquery

fromstringquery

tostringquery

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "jobId": "string",
      "profileId": "string",
      "destination": "string",
      "domain": "string",
      "type": "hard",
      "occurredAt": "2024-01-01T00:00:00Z",
      "connectionId": "string",
      "subject": "string",
      "source": "string"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

idstringrequired

jobIdstringrequired

profileIdstringrequired

destinationstringrequired

domainstringrequired

typestringrequired

hard | soft

occurredAtstringrequired

connectionIdstringrequired

subjectstringrequired

sourcestringrequired

nextCursorstringrequired

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/bounces

POSThttps://hermeticor.com/v1/bounces/suppress

Blocklist every recipient the bounce browser shows for this filter (up to 5000 addresses); lift later with a reason

Request body

application/json

typestring

hard | soft

domainstring

qstring

connectionIdstring

fromstring

tostring

{
  "type": "hard",
  "domain": "string",
  "q": "string",
  "connectionId": "string",
  "from": "2024-01-01T00:00:00Z",
  "to": "2024-01-01T00:00:00Z"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/bounces/suppress" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"type":"hard","domain":"string","q":"string","connectionId":"string","from":"2024-01-01T00:00:00Z","to":"2024-01-01T00:00:00Z"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "suppressed": 0
}

Schema

suppressedintegerrequired

4XX Default Response

Same as 4XX · GET /v1/bounces

5XX Default Response

Same as 4XX · GET /v1/bounces

DELETEhttps://hermeticor.com/v1/bounces/profiles/{id}

Hide one profile's bounce history from the browser and reset the soft-bounce count (analytics keep the events); an existing suppression stays until lifted with a reason

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "deleted": 0
}

Schema

deletedintegerrequired

4XX Default Response

Same as 4XX · GET /v1/bounces

5XX Default Response

Same as 4XX · GET /v1/bounces

GEThttps://hermeticor.com/v1/developer/requests

API request log for debugging: method, route, status and duration of authenticated calls, kept 30 days

Parameters

limitintegerquery

= 50

cursorstringquery

methodstringquery

GET | POST | PUT | PATCH | DELETE

pathstringquery

statusstringquery

ok | error

fromstringquery

tostringquery

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "method": "string",
      "path": "string",
      "status": 0,
      "durationMs": 0,
      "actorId": "string",
      "at": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

idstringrequired

methodstringrequired

pathstringrequired

statusintegerrequired

durationMsintegerrequired

actorIdstringrequired

atstringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · GET /v1/bounces

5XX Default Response

Same as 4XX · GET /v1/bounces

GEThttps://hermeticor.com/v1/delivery/settings

Soft-bounce escalation, unsubscribe mailbox and reserved transactional share

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "softBounceThreshold": 0,
  "softBounceWindowDays": 0,
  "unsubscribeMailbox": "string",
  "transactionalReservePct": 0,
  "contentBlockScore": 0,
  "messageRatePerSec": 0,
  "windowMax": 0,
  "windowSeconds": 0,
  "individualTracking": true,
  "maxRetries": 0,
  "retryDelaySeconds": 0
}

Schema

softBounceThresholdintegerrequired

softBounceWindowDaysintegerrequired

unsubscribeMailboxstringrequired

transactionalReservePctintegerrequired

contentBlockScorenumberrequired

messageRatePerSecintegerrequired

windowMaxintegerrequired

windowSecondsintegerrequired

individualTrackingbooleanrequired

maxRetriesintegerrequired

retryDelaySecondsintegerrequired

4XX Default Response

Same as 4XX · GET /v1/bounces

5XX Default Response

Same as 4XX · GET /v1/bounces

PUThttps://hermeticor.com/v1/delivery/settings

Request body

application/json

softBounceThresholdinteger

softBounceWindowDaysinteger

unsubscribeMailboxstring

transactionalReservePctinteger

contentBlockScorenumber

messageRatePerSecinteger

windowMaxinteger

windowSecondsinteger

individualTrackingboolean

maxRetriesinteger

retryDelaySecondsinteger

{
  "softBounceThreshold": 0,
  "softBounceWindowDays": 0,
  "unsubscribeMailbox": "string",
  "transactionalReservePct": 0,
  "contentBlockScore": 0,
  "messageRatePerSec": 0,
  "windowMax": 0,
  "windowSeconds": 0,
  "individualTracking": true,
  "maxRetries": 0,
  "retryDelaySeconds": 0
}

Code samples

cURL

curl -X PUT "https://hermeticor.com/v1/delivery/settings" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"softBounceThreshold":0,"softBounceWindowDays":0,"unsubscribeMailbox":"string","transactionalReservePct":0,"contentBlockScore":0,"messageRatePerSec":0,"windowMax":0,"windowSeconds":0,"individualTracking":true,"maxRetries":0,"retryDelaySeconds":0}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · GET /v1/delivery/settings

4XX Default Response

Same as 4XX · GET /v1/bounces

5XX Default Response

Same as 4XX · GET /v1/bounces

POSThttps://hermeticor.com/v1/messages/{id}/resend

Resend a stored transactional message under a new idempotency key derived from the original; consent and suppression run again

Parameters

idstringpathrequired

Request body

application/json

idempotencyKeystring

{
  "idempotencyKey": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/messages/{id}/resend" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"idempotencyKey":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

202 Default Response

Example

{
  "jobId": "string",
  "status": "queued",
  "reason": "string"
}

Schema

jobIdstringrequired

statusstringrequired

queued | blocked | deferred | duplicate

reasonstring

4XX Default Response

Same as 4XX · GET /v1/bounces

5XX Default Response

Same as 4XX · GET /v1/bounces

GEThttps://hermeticor.com/v1/send-options/{sourceKind}/{sourceId}

Attachments and custom headers applied to every send of a campaign, journey or sequence

Parameters

sourceKindstringpathrequired

campaign | workflow | sequence

sourceIdstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/send-options/{sourceKind}/{sourceId}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "sourceKind": "string",
  "sourceId": "string",
  "attachments": [
    {
      "filename": "string",
      "contentType": "string",
      "size": 0,
      "cid": "string"
    }
  ],
  "headers": {},
  "profileFileAttrs": [],
  "cc": [
    "string"
  ],
  "bcc": [
    "string"
  ],
  "postalAddressId": "string",
  "toName": "string",
  "strictLiquid": true,
  "fromOwner": true,
  "updatedAt": "2024-01-01T00:00:00Z"
}

Schema

sourceKindstringrequired

sourceIdstringrequired

attachmentsAttachmentsItem3[]required

Show child parameters

filenamestringrequired

contentTypestringrequired

sizeintegerrequired

cidstring

headersobjectrequired

profileFileAttrsstring[]required

= []

ccstring[]required

bccstring[]required

postalAddressIdstringrequired

toNamestring

strictLiquidboolean

fromOwnerboolean

updatedAtstringrequired

4XX Default Response

Same as 4XX · GET /v1/bounces

5XX Default Response

Same as 4XX · GET /v1/bounces

Next part

Updated Nov 8, 2026

Was this page helpful?