templates

Embed
Preview of the card
<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/saved-sections

Filter by name, block type and created / updated dates; sort newest, oldest, name or updated

Parameters

limitintegerquery
= 50
cursorstringquery
qstringquery
typestringquery
createdAfterstringquery
createdBeforestringquery
updatedAfterstringquery
updatedBeforestringquery
sortstringquery
newest | oldest | name | updated = newest

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/saved-sections" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "items": [
    {
      "name": "string",
      "blocks": [
        {}
      ],
      "id": "string",
      "workspaceId": "string",
      "createdAt": "2024-01-01T00:00:00Z",
      "updatedAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}
Schema
itemsItemsItem37[]required
Show child parameters
namestringrequired
blocksschema0[]required
idstringrequired
workspaceIdstringrequired
createdAtstringrequired
updatedAtstringrequired
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/saved-sections

POSThttps://hermeticor.com/v1/saved-sections

Request body

application/json
namestringrequired
blocksschema0[]required
{
  "name": "string",
  "blocks": [
    {}
  ]
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/saved-sections" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","blocks":[{}]}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

201 Default Response
Example
{
  "name": "string",
  "blocks": [
    {}
  ],
  "id": "string",
  "workspaceId": "string",
  "createdAt": "2024-01-01T00:00:00Z",
  "updatedAt": "2024-01-01T00:00:00Z"
}
Schema
namestringrequired
blocksschema0[]required
idstringrequired
workspaceIdstringrequired
createdAtstringrequired
updatedAtstringrequired
4XX Default Response

Same as 4XX · GET /v1/saved-sections

5XX Default Response

Same as 4XX · GET /v1/saved-sections

GEThttps://hermeticor.com/v1/saved-sections/{id}

Parameters

idstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/saved-sections/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 201 · POST /v1/saved-sections

4XX Default Response

Same as 4XX · GET /v1/saved-sections

5XX Default Response

Same as 4XX · GET /v1/saved-sections

DELETEhttps://hermeticor.com/v1/saved-sections/{id}

Parameters

idstringpathrequired

Code samples

cURL
curl -X DELETE "https://hermeticor.com/v1/saved-sections/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "ok": true
}
Schema
okbooleanrequired
true
4XX Default Response

Same as 4XX · GET /v1/saved-sections

5XX Default Response

Same as 4XX · GET /v1/saved-sections

PATCHhttps://hermeticor.com/v1/saved-sections/{id}

Parameters

idstringpathrequired

Request body

application/json
namestring
blocksschema0[]
{
  "name": "string",
  "blocks": [
    {}
  ]
}

Code samples

cURL
curl -X PATCH "https://hermeticor.com/v1/saved-sections/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","blocks":[{}]}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 201 · POST /v1/saved-sections

4XX Default Response

Same as 4XX · GET /v1/saved-sections

5XX Default Response

Same as 4XX · GET /v1/saved-sections

POSThttps://hermeticor.com/v1/templates/translate-variant

Draft a language variant from base blocks with AI assist (opt-in per workspace; uses the brand voice)

Request body

application/json
blocksschema0[]required
subjectstring
preheaderstring
targetLanguagestringrequired
{
  "blocks": [
    {}
  ],
  "subject": "string",
  "preheader": "string",
  "targetLanguage": "string"
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/templates/translate-variant" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"blocks":[{}],"subject":"string","preheader":"string","targetLanguage":"string"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "blocks": [
    {}
  ],
  "subject": "string",
  "preheader": "string",
  "model": "string",
  "draft": true
}
Schema
blocksschema0[]required
subjectstring
preheaderstring
modelstringrequired
draftbooleanrequired
true
4XX Default Response

Same as 4XX · GET /v1/saved-sections

5XX Default Response

Same as 4XX · GET /v1/saved-sections

GEThttps://hermeticor.com/v1/qa-preview/connection

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/qa-preview/connection" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "configured": true,
  "vendor": "string",
  "name": "string",
  "vendors": [
    "string"
  ]
}
Schema
configuredbooleanrequired
vendorstringrequired
namestringrequired
vendorsstring[]required
4XX Default Response

Same as 4XX · GET /v1/saved-sections

5XX Default Response

Same as 4XX · GET /v1/saved-sections

PUThttps://hermeticor.com/v1/qa-preview/connection

Connect a real-client preview service. The API key is stored encrypted and never returned.

Request body

application/json
vendorstringrequired
namestringrequired
apiKeystring
apiSecretstring
{
  "vendor": "string",
  "name": "string",
  "apiKey": "string",
  "apiSecret": "string"
}

Code samples

cURL
curl -X PUT "https://hermeticor.com/v1/qa-preview/connection" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"vendor":"string","name":"string","apiKey":"string","apiSecret":"string"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 200 · GET /v1/qa-preview/connection

4XX Default Response

Same as 4XX · GET /v1/saved-sections

5XX Default Response

Same as 4XX · GET /v1/saved-sections

DELETEhttps://hermeticor.com/v1/qa-preview/connection

Code samples

cURL
curl -X DELETE "https://hermeticor.com/v1/qa-preview/connection" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 200 · GET /v1/qa-preview/connection

4XX Default Response

Same as 4XX · GET /v1/saved-sections

5XX Default Response

Same as 4XX · GET /v1/saved-sections

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

Submit the saved version to the connected preview service

Parameters

idstringpathrequired

Request body

application/json
versionIdstring
clientsstring[]
{
  "versionId": "string",
  "clients": [
    "string"
  ]
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/templates/{id}/client-previews" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"versionId":"string","clients":["string"]}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

202 Default Response
Example
{
  "externalId": "string"
}
Schema
externalIdstringrequired
4XX Default Response

Same as 4XX · GET /v1/saved-sections

5XX Default Response

Same as 4XX · GET /v1/saved-sections

GEThttps://hermeticor.com/v1/qa-preview/clients

Mail clients the connected preview service offers, and its credit balance when it reports one

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/qa-preview/clients" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "clients": [
    {
      "id": "string",
      "name": "string",
      "platform": "web",
      "defaultSelected": true
    }
  ],
  "credits": {
    "remaining": 0,
    "resetsAt": "string"
  }
}
Schema
clientsobject[]required
Show child parameters
idstringrequired
namestringrequired
platformstringrequired
web | desktop | mobile
defaultSelectedbooleanrequired
creditsobjectrequired
Show child parameters
remainingnumberrequired
resetsAtstringrequired
4XX Default Response

Same as 4XX · GET /v1/saved-sections

5XX Default Response

Same as 4XX · GET /v1/saved-sections

Updated