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>

GEThttps://hermeticor.com/v1/templates/{id}/client-preview-runs

Inbox preview run history for a template, newest first

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/templates/{id}/client-preview-runs" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "templateId": "string",
      "versionId": "string",
      "vendor": "string",
      "externalId": "string",
      "clients": [
        "string"
      ],
      "status": "pending",
      "shots": [
        {
          "client": "string",
          "url": "string"
        }
      ],
      "error": "string",
      "createdBy": "string",
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

idstringrequired

templateIdstringrequired

versionIdstringrequired

vendorstringrequired

externalIdstringrequired

clientsstring[]required

statusstringrequired

pending | done | failed

shotsobject[]required

Show child parameters

clientstringrequired

urlstringrequired

errorstringrequired

createdBystringrequired

createdAtstringrequired

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/templates/{id}/client-preview-runs

POSThttps://hermeticor.com/v1/client-previews/{externalId}

Poll the preview service for a run and save its latest result

Parameters

externalIdstringpathrequired

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/client-previews/{externalId}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "status": "pending",
  "error": "string",
  "shots": [
    {
      "client": "string",
      "url": "string"
    }
  ]
}

Schema

statusstringrequired

pending | done | failed

errorstring

shotsobject[]required

Show child parameters

clientstringrequired

urlstringrequired

4XX Default Response

Same as 4XX · GET /v1/templates/{id}/client-preview-runs

5XX Default Response

Same as 4XX · GET /v1/templates/{id}/client-preview-runs

GEThttps://hermeticor.com/v1/templates/{id}/optimizer

Writing checks on the saved version, weighed by how similar senders' email campaigns perform (peer benchmarks, or the static reference ranges)

Parameters

versionIdstringquery

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "score": 0,
  "contentScore": 0,
  "checks": [
    {
      "id": "string",
      "level": "good",
      "title": "string",
      "detail": "string"
    }
  ],
  "stats": {
    "words": 0,
    "sentences": 0,
    "avgSentenceWords": 0,
    "links": 0,
    "images": 0
  },
  "benchmark": [
    {
      "metric": "open",
      "feature": "string",
      "yours": 0,
      "typical": 0,
      "good": 0,
      "rank": 0,
      "source": "network",
      "standing": "behind"
    }
  ],
  "optedIn": true
}

Schema

scoreintegerrequired

contentScoreintegerrequired

checksChecksItem[]required

Show child parameters

idstringrequired

levelstringrequired

good | tip | fix

titlestringrequired

detailstringrequired

statsobjectrequired

Show child parameters

wordsintegerrequired

sentencesintegerrequired

avgSentenceWordsintegerrequired

linksintegerrequired

imagesintegerrequired

benchmarkobject[]required

Show child parameters

metricstringrequired

open | click

featurestringrequired

yoursnumberrequired

typicalnumberrequired

goodnumberrequired

rankintegerrequired

sourcestringrequired

network | local_peers | static_reference

standingstringrequired

behind | level | ahead | unknown

optedInbooleanrequired

4XX Default Response

Same as 4XX · GET /v1/templates/{id}/client-preview-runs

5XX Default Response

Same as 4XX · GET /v1/templates/{id}/client-preview-runs

GEThttps://hermeticor.com/v1/template-folders/{id}

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "id": "string",
  "kind": "template",
  "name": "string",
  "parentId": "string",
  "itemCount": 0,
  "createdAt": "2024-01-01T00:00:00Z"
}

Schema

idstringrequired

kindstringrequired

template | asset

namestringrequired

parentIdstringrequired

itemCountnumberrequired

createdAtstringrequired

4XX Default Response

Same as 4XX · GET /v1/templates/{id}/client-preview-runs

5XX Default Response

Same as 4XX · GET /v1/templates/{id}/client-preview-runs

DELETEhttps://hermeticor.com/v1/template-folders/{id}

Parameters

idstringpathrequired

Code samples

cURL

curl -X DELETE "https://hermeticor.com/v1/template-folders/{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/templates/{id}/client-preview-runs

5XX Default Response

Same as 4XX · GET /v1/templates/{id}/client-preview-runs

PATCHhttps://hermeticor.com/v1/template-folders/{id}

Parameters

idstringpathrequired

Request body

application/json

namestring

parentIdstring

{
  "name": "string",
  "parentId": "string"
}

Code samples

cURL

curl -X PATCH "https://hermeticor.com/v1/template-folders/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","parentId":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · GET /v1/template-folders/{id}

4XX Default Response

Same as 4XX · GET /v1/templates/{id}/client-preview-runs

5XX Default Response

Same as 4XX · GET /v1/templates/{id}/client-preview-runs

GEThttps://hermeticor.com/v1/asset-folders

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "kind": "template",
      "name": "string",
      "parentId": "string",
      "itemCount": 0,
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem34[]required

Show child parameters

idstringrequired

kindstringrequired

template | asset

namestringrequired

parentIdstringrequired

itemCountnumberrequired

createdAtstringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · GET /v1/templates/{id}/client-preview-runs

5XX Default Response

Same as 4XX · GET /v1/templates/{id}/client-preview-runs

POSThttps://hermeticor.com/v1/asset-folders

Request body

application/json

namestringrequired

parentIdstring

{
  "name": "string",
  "parentId": "string"
}

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Same as 200 · GET /v1/template-folders/{id}

4XX Default Response

Same as 4XX · GET /v1/templates/{id}/client-preview-runs

5XX Default Response

Same as 4XX · GET /v1/templates/{id}/client-preview-runs

GEThttps://hermeticor.com/v1/asset-folders/{id}

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · GET /v1/template-folders/{id}

4XX Default Response

Same as 4XX · GET /v1/templates/{id}/client-preview-runs

5XX Default Response

Same as 4XX · GET /v1/templates/{id}/client-preview-runs

Next part

Updated Nov 8, 2026

Was this page helpful?