templates

Embed

<a href="https://hermeticor.com/docs/ref-templates"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/9c29e4ff-ee5d-4be6-9133-6951bf2d35cb/social-card.svg?v=3e7ae33eec8b" alt="templates" width="600" height="315"></a>

POSThttps://hermeticor.com/v1/assets

Upload a file (multipart field "file", optional fields folderId, filename, access first). Images up to 5 MB; other allowed types (Settings > Media) up to 25 MB

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "id": "string",
  "filename": "string",
  "contentType": "string",
  "bytes": 0,
  "width": 0,
  "height": 0,
  "url": "string",
  "thumbUrl": null,
  "altText": "string",
  "folderId": "string",
  "language": "string",
  "tags": [],
  "scanStatus": "unscanned",
  "access": "public_indexable",
  "createdAt": "2024-01-01T00:00:00Z"
}

Schema

idstringrequired

filenamestringrequired

contentTypestringrequired

bytesnumberrequired

widthnumberrequired

heightnumberrequired

urlstringrequired

thumbUrlstringrequired

= null

altTextstringrequired

folderIdstringrequired

languagestringrequired

tagsstring[]required

= []

scanStatusstringrequired

unscanned | clean | quarantined = unscanned

accessstringrequired

public_indexable | public_not_indexable | private = public_indexable

createdAtstringrequired

4XX Default Response

Example

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

Schema

errorobjectrequired

Show child parameters

codestringrequired

messagestringrequired

detailsobject

5XX Default Response

Same as 4XX · POST /v1/assets

GEThttps://hermeticor.com/v1/assets/{id}

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/assets

4XX Default Response

Same as 4XX · POST /v1/assets

5XX Default Response

Same as 4XX · POST /v1/assets

DELETEhttps://hermeticor.com/v1/assets/{id}

Parameters

idstringpathrequired

Code samples

cURL

curl -X DELETE "https://hermeticor.com/v1/assets/{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 · POST /v1/assets

5XX Default Response

Same as 4XX · POST /v1/assets

PATCHhttps://hermeticor.com/v1/assets/{id}

Parameters

idstringpathrequired

Request body

application/json

filenamestring

altTextstring

folderIdstring

languagestring

tagsstring[]

accessstring

public_indexable | public_not_indexable | private

{
  "filename": "string",
  "altText": "string",
  "folderId": "string",
  "language": "string",
  "tags": [
    "string"
  ],
  "access": "public_indexable"
}

Code samples

cURL

curl -X PATCH "https://hermeticor.com/v1/assets/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"filename":"string","altText":"string","folderId":"string","language":"string","tags":["string"],"access":"public_indexable"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/assets

4XX Default Response

Same as 4XX · POST /v1/assets

5XX Default Response

Same as 4XX · POST /v1/assets

GEThttps://hermeticor.com/v1/tracking-domains

Parameters

limitintegerquery

= 50

cursorstringquery

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "domain": "string",
      "status": "pending",
      "cnameTarget": "string",
      "verifiedAt": "2024-01-01T00:00:00Z",
      "lastCheckedAt": "2024-01-01T00:00:00Z",
      "lastError": "string",
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem36[]required

Show child parameters

idstringrequired

domainstringrequired

statusstringrequired

pending | verified | failed

cnameTargetstringrequired

verifiedAtstringrequired

lastCheckedAtstringrequired

lastErrorstringrequired

createdAtstringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · POST /v1/assets

5XX Default Response

Same as 4XX · POST /v1/assets

POSThttps://hermeticor.com/v1/tracking-domains

Request body

application/json

domainstringrequired

{
  "domain": "string"
}

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "id": "string",
  "domain": "string",
  "status": "pending",
  "cnameTarget": "string",
  "verifiedAt": "2024-01-01T00:00:00Z",
  "lastCheckedAt": "2024-01-01T00:00:00Z",
  "lastError": "string",
  "createdAt": "2024-01-01T00:00:00Z"
}

Schema

idstringrequired

domainstringrequired

statusstringrequired

pending | verified | failed

cnameTargetstringrequired

verifiedAtstringrequired

lastCheckedAtstringrequired

lastErrorstringrequired

createdAtstringrequired

4XX Default Response

Same as 4XX · POST /v1/assets

5XX Default Response

Same as 4XX · POST /v1/assets

POSThttps://hermeticor.com/v1/tracking-domains/{id}/verify

Queue a CNAME verification

Parameters

idstringpathrequired

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/tracking-domains/{id}/verify" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

202 Default Response

Same as 201 · POST /v1/tracking-domains

4XX Default Response

Same as 4XX · POST /v1/assets

5XX Default Response

Same as 4XX · POST /v1/assets

GEThttps://hermeticor.com/v1/tracking-domains/{id}

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/tracking-domains

4XX Default Response

Same as 4XX · POST /v1/assets

5XX Default Response

Same as 4XX · POST /v1/assets

DELETEhttps://hermeticor.com/v1/tracking-domains/{id}

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · DELETE /v1/assets/{id}

4XX Default Response

Same as 4XX · POST /v1/assets

5XX Default Response

Same as 4XX · POST /v1/assets

POSThttps://hermeticor.com/v1/templates/{id}/test-send

Send the current version of a template to a seed list

Parameters

idstringpathrequired

Request body

application/json

seedListIdstringrequired

connectionIdstringrequired

purposestring

marketing | prospecting | transactional | operational = marketing

{
  "seedListId": "string",
  "connectionId": "string",
  "purpose": "marketing"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/templates/{id}/test-send" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"seedListId":"string","connectionId":"string","purpose":"marketing"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "sent": 0,
  "blocked": 0,
  "jobIds": [
    "string"
  ]
}

Schema

sentintegerrequired

blockedintegerrequired

jobIdsstring[]required

4XX Default Response

Same as 4XX · POST /v1/assets

5XX Default Response

Same as 4XX · POST /v1/assets

Next part

Updated Nov 8, 2026

Was this page helpful?