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>

PUThttps://hermeticor.com/v1/transactional/definitions/{id}/translations/{locale}

Parameters

idstringpathrequired

localestringpathrequired

Request body

application/json

statusstring

draft | approved = approved

contentobjectrequired

{
  "status": "approved",
  "content": {}
}

Code samples

cURL

curl -X PUT "https://hermeticor.com/v1/transactional/definitions/{id}/translations/{locale}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"status":"approved","content":{}}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "id": "string",
  "locale": "string",
  "status": "string"
}

Schema

idstringrequired

localestringrequired

statusstringrequired

4XX Default Response

Example

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

Schema

errorobjectrequired

Show child parameters

codestringrequired

messagestringrequired

detailsobject

5XX Default Response

Same as 4XX · PUT /v1/transactional/definitions/{id}/translations/{locale}

POSThttps://hermeticor.com/v1/transactional/batches/{batchId}/cancel

Cancel every queued or deferred message sent with this batchId

Parameters

batchIdstringpathrequired

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/transactional/batches/{batchId}/cancel" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "cancelled": 0
}

Schema

cancelledintegerrequired

4XX Default Response

Same as 4XX · PUT /v1/transactional/definitions/{id}/translations/{locale}

5XX Default Response

Same as 4XX · PUT /v1/transactional/definitions/{id}/translations/{locale}

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

Sent/delivered/bounced/complained for today, 7, 30, 60 and 90 days; optionally one sender or channel (sender and account info rollups)

Parameters

senderIdentityIdstringquery

channelstringquery

email | sms | whatsapp | push | postcard

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "period": "string",
      "sent": 0,
      "delivered": 0,
      "bounced": 0,
      "complained": 0,
      "blocked": 0,
      "opens": 0,
      "clicks": 0
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem50[]required

Show child parameters

periodstringrequired

sentintegerrequired

deliveredintegerrequired

bouncedintegerrequired

complainedintegerrequired

blockedintegerrequired

opensintegerrequired

clicksintegerrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · PUT /v1/transactional/definitions/{id}/translations/{locale}

5XX Default Response

Same as 4XX · PUT /v1/transactional/definitions/{id}/translations/{locale}

GEThttps://hermeticor.com/v1/transactional/metadata-keys

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "key": "string",
      "messages": 0
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

keystringrequired

messagesintegerrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · PUT /v1/transactional/definitions/{id}/translations/{locale}

5XX Default Response

Same as 4XX · PUT /v1/transactional/definitions/{id}/translations/{locale}

GEThttps://hermeticor.com/v1/smtp-credentials

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "name": "string",
      "username": "string",
      "lastUsedAt": "2024-01-01T00:00:00Z",
      "revokedAt": "2024-01-01T00:00:00Z",
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem51[]required

Show child parameters

idstringrequired

namestringrequired

usernamestringrequired

lastUsedAtstringrequired

revokedAtstringrequired

createdAtstringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · PUT /v1/transactional/definitions/{id}/translations/{locale}

5XX Default Response

Same as 4XX · PUT /v1/transactional/definitions/{id}/translations/{locale}

POSThttps://hermeticor.com/v1/smtp-credentials

Issue an SMTP relay credential; the secret is returned once

Request body

application/json

namestringrequired

{
  "name": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/smtp-credentials" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "id": "string",
  "name": "string",
  "username": "string",
  "secret": "string"
}

Schema

idstringrequired

namestringrequired

usernamestringrequired

secretstringrequired

4XX Default Response

Same as 4XX · PUT /v1/transactional/definitions/{id}/translations/{locale}

5XX Default Response

Same as 4XX · PUT /v1/transactional/definitions/{id}/translations/{locale}

GEThttps://hermeticor.com/v1/smtp-credentials/{id}

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "id": "string",
  "name": "string",
  "username": "string",
  "lastUsedAt": "2024-01-01T00:00:00Z",
  "revokedAt": "2024-01-01T00:00:00Z",
  "createdAt": "2024-01-01T00:00:00Z"
}

Schema

idstringrequired

namestringrequired

usernamestringrequired

lastUsedAtstringrequired

revokedAtstringrequired

createdAtstringrequired

4XX Default Response

Same as 4XX · PUT /v1/transactional/definitions/{id}/translations/{locale}

5XX Default Response

Same as 4XX · PUT /v1/transactional/definitions/{id}/translations/{locale}

DELETEhttps://hermeticor.com/v1/smtp-credentials/{id}

Parameters

idstringpathrequired

Code samples

cURL

curl -X DELETE "https://hermeticor.com/v1/smtp-credentials/{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 · PUT /v1/transactional/definitions/{id}/translations/{locale}

5XX Default Response

Same as 4XX · PUT /v1/transactional/definitions/{id}/translations/{locale}

POSThttps://hermeticor.com/v1/smtp-credentials/{id}/reset

Replace the secret in place; the old one stops working and the new one is returned once

Parameters

idstringpathrequired

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/smtp-credentials/{id}/reset" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/smtp-credentials

4XX Default Response

Same as 4XX · PUT /v1/transactional/definitions/{id}/translations/{locale}

5XX Default Response

Same as 4XX · PUT /v1/transactional/definitions/{id}/translations/{locale}

Next part

Updated Nov 8, 2026

Was this page helpful?