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/transactional/scheduled

Parameters

limitintegerquery

= 50

cursorstringquery

fromstringquery

tostringquery

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "idempotencyKey": "string",
      "purpose": "marketing",
      "channel": "email",
      "profileId": "string",
      "destination": "string",
      "connectionId": "string",
      "senderIdentityId": "string",
      "sourceKind": "campaign",
      "sourceId": "string",
      "stepKey": "string",
      "templateVersionId": "string",
      "variantKey": "string",
      "status": "queued",
      "blockReason": "string",
      "errorClass": "string",
      "decisionLog": [
        {
          "stage": "string",
          "outcome": "allow",
          "reason": "string",
          "at": "2024-01-01T00:00:00Z"
        }
      ],
      "scheduledFor": "2024-01-01T00:00:00Z",
      "sentAt": "2024-01-01T00:00:00Z",
      "providerMessageId": "string",
      "subject": "string",
      "tags": [
        "string"
      ],
      "metadata": {},
      "createdAt": "2024-01-01T00:00:00Z",
      "updatedAt": "2024-01-01T00:00:00Z"
    }
  ]
}

Schema

itemsItemsItem42[]required

Show child parameters

idstringrequired

idempotencyKeystringrequired

purposestringrequired

marketing | prospecting | transactional | operational

channelstringrequired

email | sms | whatsapp | push | postcard

profileIdstringrequired

destinationstringrequired

connectionIdstringrequired

senderIdentityIdstringrequired

sourceKindstringrequired

campaign | workflow | sequence | api

sourceIdstringrequired

stepKeystringrequired

templateVersionIdstringrequired

variantKeystringrequired

statusstringrequired

blockReasonstringrequired

errorClassstringrequired

decisionLogDecisionLogItem[]required

Show child parameters

stagestringrequired

outcomestringrequired

allow | block | defer

reasonstring

atstring

scheduledForstringrequired

sentAtstringrequired

providerMessageIdstringrequired

subjectstringrequired

tagsstring[]required

metadataobjectrequired

createdAtstringrequired

updatedAtstringrequired

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/transactional/scheduled

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

Cancel one scheduled (queued/deferred) message

Parameters

idstringpathrequired

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/messages/{id}/cancel" \
  -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/transactional/scheduled

5XX Default Response

Same as 4XX · GET /v1/transactional/scheduled

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

Parameters

idstringpathrequired

Request body

application/json

scheduledForstringrequired

{
  "scheduledFor": "2024-01-01T00:00:00Z"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/messages/{id}/reschedule" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"scheduledFor":"2024-01-01T00:00:00Z"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "id": "string",
  "scheduledFor": "string"
}

Schema

idstringrequired

scheduledForstringrequired

4XX Default Response

Same as 4XX · GET /v1/transactional/scheduled

5XX Default Response

Same as 4XX · GET /v1/transactional/scheduled

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

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "tag": "string",
      "sent": 0,
      "delivered": 0,
      "bounced": 0,
      "complained": 0,
      "blocked": 0,
      "opens": 0,
      "clicks": 0,
      "lastUsedAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem43[]required

Show child parameters

tagstringrequired

sentintegerrequired

deliveredintegerrequired

bouncedintegerrequired

complainedintegerrequired

blockedintegerrequired

opensintegerrequired

clicksintegerrequired

lastUsedAtstringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · GET /v1/transactional/scheduled

5XX Default Response

Same as 4XX · GET /v1/transactional/scheduled

GEThttps://hermeticor.com/v1/transactional/tags/{tag}

Parameters

tagstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "tag": "string",
  "sent": 0,
  "delivered": 0,
  "bounced": 0,
  "complained": 0,
  "blocked": 0,
  "opens": 0,
  "clicks": 0,
  "lastUsedAt": "2024-01-01T00:00:00Z"
}

Schema

tagstringrequired

sentintegerrequired

deliveredintegerrequired

bouncedintegerrequired

complainedintegerrequired

blockedintegerrequired

opensintegerrequired

clicksintegerrequired

lastUsedAtstringrequired

4XX Default Response

Same as 4XX · GET /v1/transactional/scheduled

5XX Default Response

Same as 4XX · GET /v1/transactional/scheduled

DELETEhttps://hermeticor.com/v1/transactional/tags/{tag}

Remove a tag from every message that carries it

Parameters

tagstringpathrequired

Code samples

cURL

curl -X DELETE "https://hermeticor.com/v1/transactional/tags/{tag}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "messages": 0
}

Schema

messagesintegerrequired

4XX Default Response

Same as 4XX · GET /v1/transactional/scheduled

5XX Default Response

Same as 4XX · GET /v1/transactional/scheduled

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

Daily send/delivery/bounce counts grouped by tag, sender, template or a metadata key

Parameters

groupBystringquery

tag | sender | template | metadata = tag

keystringquery

fromstringquery

tostringquery

tagstringquery

channelstringquery

email | sms | whatsapp | push | postcard

granularitystringquery

day | hour = day

statusstringquery

qstringquery

metadatastringquery

senderIdentityIdstringquery

templateIdstringquery

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "day": "string",
      "group": "string",
      "sent": 0,
      "delivered": 0,
      "bounced": 0,
      "complained": 0
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

daystringrequired

groupstringrequired

sentintegerrequired

deliveredintegerrequired

bouncedintegerrequired

complainedintegerrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · GET /v1/transactional/scheduled

5XX Default Response

Same as 4XX · GET /v1/transactional/scheduled

GEThttps://hermeticor.com/v1/inbound/domains

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "domain": "string",
      "mxVerifiedAt": "2024-01-01T00:00:00Z",
      "lastCheckedAt": "2024-01-01T00:00:00Z",
      "mx": {},
      "expectedMx": "string",
      "createdAt": "2024-01-01T00:00:00Z",
      "receiveUrls": {}
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem44[]required

Show child parameters

idstringrequired

domainstringrequired

mxVerifiedAtstringrequired

lastCheckedAtstringrequired

mxrequired

expectedMxstringrequired

createdAtstringrequired

receiveUrlsobject

nextCursorstringrequired

4XX Default Response

Same as 4XX · GET /v1/transactional/scheduled

5XX Default Response

Same as 4XX · GET /v1/transactional/scheduled

Next part

Updated Nov 8, 2026

Was this page helpful?