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/send-options/{sourceKind}/{sourceId}

Replace the attachments (base64, stored in object storage) and allowlisted headers of a source; reserved headers are rejected

Parameters

sourceKindstringpathrequired

campaign | workflow | sequence

sourceIdstringpathrequired

Request body

application/json

attachmentsAttachmentsItem[]

= []

Show child parameters

filenamestringrequired

contentTypestringrequired

contentBase64stringrequired

cidstring

headersobject

= {}

ccstring[]

= []

bccstring[]

= []

profileFileAttrsstring[]

= []

{
  "attachments": [],
  "headers": {},
  "cc": [],
  "bcc": [],
  "profileFileAttrs": []
}

Code samples

cURL

curl -X PUT "https://hermeticor.com/v1/send-options/{sourceKind}/{sourceId}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"attachments":[],"headers":{},"cc":[],"bcc":[],"profileFileAttrs":[]}'

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

Example

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

Schema

errorobjectrequired

Show child parameters

codestringrequired

messagestringrequired

detailsobject

5XX Default Response

Same as 4XX · PUT /v1/send-options/{sourceKind}/{sourceId}

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

Parameters

sourceKindstringpathrequired

campaign | workflow | sequence

sourceIdstringpathrequired

Code samples

cURL

curl -X DELETE "https://hermeticor.com/v1/send-options/{sourceKind}/{sourceId}" \
  -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/send-options/{sourceKind}/{sourceId}

5XX Default Response

Same as 4XX · PUT /v1/send-options/{sourceKind}/{sourceId}

PUThttps://hermeticor.com/v1/send-options/{sourceKind}/{sourceId}/footer-address

Choose which saved address prints in the email footer of a campaign, journey or sequence (null = workspace address); attachments and headers are untouched

Parameters

sourceKindstringpathrequired

campaign | workflow | sequence

sourceIdstringpathrequired

Request body

application/json

postalAddressIdstringrequired

{
  "postalAddressId": "string"
}

Code samples

cURL

curl -X PUT "https://hermeticor.com/v1/send-options/{sourceKind}/{sourceId}/footer-address" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"postalAddressId":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · PUT /v1/send-options/{sourceKind}/{sourceId}

4XX Default Response

Same as 4XX · PUT /v1/send-options/{sourceKind}/{sourceId}

5XX Default Response

Same as 4XX · PUT /v1/send-options/{sourceKind}/{sourceId}

PUThttps://hermeticor.com/v1/send-options/{sourceKind}/{sourceId}/to-name

Set the recipient display-name template for the To header of a campaign, journey or sequence (for example {{ profile.firstName }}; null clears it)

Parameters

sourceKindstringpathrequired

campaign | workflow | sequence

sourceIdstringpathrequired

Request body

application/json

toNamestringrequired

{
  "toName": "string"
}

Code samples

cURL

curl -X PUT "https://hermeticor.com/v1/send-options/{sourceKind}/{sourceId}/to-name" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"toName":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · PUT /v1/send-options/{sourceKind}/{sourceId}

4XX Default Response

Same as 4XX · PUT /v1/send-options/{sourceKind}/{sourceId}

5XX Default Response

Same as 4XX · PUT /v1/send-options/{sourceKind}/{sourceId}

GEThttps://hermeticor.com/v1/soft-bounce-allowlist

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "value": "string",
      "note": "string",
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem178[]required

Show child parameters

idstringrequired

valuestringrequired

notestringrequired

createdAtstringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · PUT /v1/send-options/{sourceKind}/{sourceId}

5XX Default Response

Same as 4XX · PUT /v1/send-options/{sourceKind}/{sourceId}

POSThttps://hermeticor.com/v1/soft-bounce-allowlist

Exempt an address or domain from automatic soft-bounce suppression

Request body

application/json

valuestringrequired

notestring

{
  "value": "string",
  "note": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/soft-bounce-allowlist" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"value":"string","note":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "id": "string",
  "value": "string",
  "note": "string",
  "createdAt": "2024-01-01T00:00:00Z"
}

Schema

idstringrequired

valuestringrequired

notestringrequired

createdAtstringrequired

4XX Default Response

Same as 4XX · PUT /v1/send-options/{sourceKind}/{sourceId}

5XX Default Response

Same as 4XX · PUT /v1/send-options/{sourceKind}/{sourceId}

DELETEhttps://hermeticor.com/v1/soft-bounce-allowlist/{id}

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · DELETE /v1/send-options/{sourceKind}/{sourceId}

4XX Default Response

Same as 4XX · PUT /v1/send-options/{sourceKind}/{sourceId}

5XX Default Response

Same as 4XX · PUT /v1/send-options/{sourceKind}/{sourceId}

GEThttps://hermeticor.com/v1/soft-bounce-allowlist/export

CSV of the allowlist

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/soft-bounce-allowlist/export" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

{}

4XX Default Response

Same as 4XX · PUT /v1/send-options/{sourceKind}/{sourceId}

5XX Default Response

Same as 4XX · PUT /v1/send-options/{sourceKind}/{sourceId}

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

Parameters

limitintegerquery

Page size; omitted returns the whole list

cursorstringquery

Opaque: the nextCursor of the previous page

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "locale": "string",
      "status": "string",
      "content": {}
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem49[]required

Show child parameters

idstringrequired

localestringrequired

statusstringrequired

contentobjectrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · PUT /v1/send-options/{sourceKind}/{sourceId}

5XX Default Response

Same as 4XX · PUT /v1/send-options/{sourceKind}/{sourceId}

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

Parameters

idstringpathrequired

contentIdstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

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

Schema

idstringrequired

localestringrequired

statusstringrequired

contentobjectrequired

4XX Default Response

Same as 4XX · PUT /v1/send-options/{sourceKind}/{sourceId}

5XX Default Response

Same as 4XX · PUT /v1/send-options/{sourceKind}/{sourceId}

Next part

Updated Nov 8, 2026

Was this page helpful?