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/inbound/mail

Parameters

domainIdstringquery

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/inbound/mail" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "domainId": "string",
      "provider": "string",
      "fromAddr": "string",
      "toAddr": "string",
      "subject": "string",
      "text": "string",
      "html": "string",
      "attachments": [
        {
          "filename": "string",
          "contentType": "string",
          "size": 0,
          "downloadable": true
        }
      ],
      "receivedAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem47[]required

Show child parameters

idstringrequired

domainIdstringrequired

providerstringrequired

fromAddrstringrequired

toAddrstringrequired

subjectstringrequired

textstringrequired

htmlstringrequired

attachmentsAttachmentsItem2[]required

Show child parameters

filenamestringrequired

contentTypestringrequired

sizeintegerrequired

downloadablebooleanrequired

receivedAtstringrequired

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/inbound/mail

GEThttps://hermeticor.com/v1/inbound/mail/{id}

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "id": "string",
  "domainId": "string",
  "provider": "string",
  "fromAddr": "string",
  "toAddr": "string",
  "subject": "string",
  "text": "string",
  "html": "string",
  "attachments": [
    {
      "filename": "string",
      "contentType": "string",
      "size": 0,
      "downloadable": true
    }
  ],
  "receivedAt": "2024-01-01T00:00:00Z"
}

Schema

idstringrequired

domainIdstringrequired

providerstringrequired

fromAddrstringrequired

toAddrstringrequired

subjectstringrequired

textstringrequired

htmlstringrequired

attachmentsAttachmentsItem2[]required

Show child parameters

filenamestringrequired

contentTypestringrequired

sizeintegerrequired

downloadablebooleanrequired

receivedAtstringrequired

4XX Default Response

Same as 4XX · GET /v1/inbound/mail

5XX Default Response

Same as 4XX · GET /v1/inbound/mail

GEThttps://hermeticor.com/v1/inbound/mail/{id}/attachments/{index}

Download one attachment of a received inbound mail

Parameters

idstringpathrequired

indexintegerpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/inbound/mail/{id}/attachments/{index}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

{}

4XX Default Response

Same as 4XX · GET /v1/inbound/mail

5XX Default Response

Same as 4XX · GET /v1/inbound/mail

GEThttps://hermeticor.com/v1/inbound/events/{id}

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "id": "string",
  "routeId": "string",
  "status": "string",
  "attempts": 0,
  "lastError": "string",
  "createdAt": "2024-01-01T00:00:00Z",
  "payload": {}
}

Schema

idstringrequired

routeIdstringrequired

statusstringrequired

attemptsintegerrequired

lastErrorstringrequired

createdAtstringrequired

payloadrequired

4XX Default Response

Same as 4XX · GET /v1/inbound/mail

5XX Default Response

Same as 4XX · GET /v1/inbound/mail

GEThttps://hermeticor.com/v1/transactional/definitions

Parameters

limitintegerquery

= 50

cursorstringquery

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "channel": "email",
      "templateId": "string",
      "settings": {
        "subject": "string",
        "fromEmail": "string",
        "fromName": "string",
        "replyTo": "string",
        "cc": [
          "string"
        ],
        "bcc": [
          "string"
        ],
        "tags": [
          "string"
        ],
        "tracking": {
          "opens": true,
          "clicks": true
        },
        "route": {
          "connectionId": "string",
          "poolId": "string",
          "routePolicyId": "string"
        }
      },
      "status": "string",
      "createdAt": "2024-01-01T00:00:00Z",
      "updatedAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem48[]required

Show child parameters

idstringrequired

namestringrequired

descriptionstringrequired

channelstringrequired

email | sms | whatsapp | push | postcard

templateIdstringrequired

settingsobjectrequired

Show child parameters

subjectstring

fromEmailstring

fromNamestring

replyTostring

ccstring[]

bccstring[]

tagsstring[]

trackingobject

routeobject

statusstringrequired

createdAtstringrequired

updatedAtstringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · GET /v1/inbound/mail

5XX Default Response

Same as 4XX · GET /v1/inbound/mail

POSThttps://hermeticor.com/v1/transactional/definitions

Request body

application/json

namestringrequired

descriptionstring

channelstring

email | sms | whatsapp | push | postcard = email

templateIdstringrequired

settingsobject

= {}

Show child parameters

subjectstring

fromEmailstring

fromNamestring

replyTostring

ccstring[]

bccstring[]

tagsstring[]

trackingobject

Show child parameters

opensboolean

clicksboolean

routeobject

Show child parameters

connectionIdstring

poolIdstring

routePolicyIdstring

{
  "name": "string",
  "description": "string",
  "channel": "email",
  "templateId": "string",
  "settings": {}
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/transactional/definitions" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","description":"string","channel":"email","templateId":"string","settings":{}}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "id": "string",
  "name": "string",
  "description": "string",
  "channel": "email",
  "templateId": "string",
  "settings": {
    "subject": "string",
    "fromEmail": "string",
    "fromName": "string",
    "replyTo": "string",
    "cc": [
      "string"
    ],
    "bcc": [
      "string"
    ],
    "tags": [
      "string"
    ],
    "tracking": {
      "opens": true,
      "clicks": true
    },
    "route": {
      "connectionId": "string",
      "poolId": "string",
      "routePolicyId": "string"
    }
  },
  "status": "string",
  "createdAt": "2024-01-01T00:00:00Z",
  "updatedAt": "2024-01-01T00:00:00Z"
}

Schema

idstringrequired

namestringrequired

descriptionstringrequired

channelstringrequired

email | sms | whatsapp | push | postcard

templateIdstringrequired

settingsobjectrequired

Show child parameters

subjectstring

fromEmailstring

fromNamestring

replyTostring

ccstring[]

bccstring[]

tagsstring[]

trackingobject

Show child parameters

opensboolean

clicksboolean

routeobject

Show child parameters

connectionIdstring

poolIdstring

routePolicyIdstring

statusstringrequired

createdAtstringrequired

updatedAtstringrequired

4XX Default Response

Same as 4XX · GET /v1/inbound/mail

5XX Default Response

Same as 4XX · GET /v1/inbound/mail

GEThttps://hermeticor.com/v1/transactional/definitions/{id}

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/transactional/definitions

4XX Default Response

Same as 4XX · GET /v1/inbound/mail

5XX Default Response

Same as 4XX · GET /v1/inbound/mail

DELETEhttps://hermeticor.com/v1/transactional/definitions/{id}

Parameters

idstringpathrequired

Code samples

cURL

curl -X DELETE "https://hermeticor.com/v1/transactional/definitions/{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/inbound/mail

5XX Default Response

Same as 4XX · GET /v1/inbound/mail

Next part

Updated Nov 8, 2026

Was this page helpful?