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>

PUThttps://hermeticor.com/v1/templates/{id}/languages/{locale}

Create or replace the language variant

Parameters

idstringpathrequired

localestringpathrequired

Request body

application/json

statusstring

draft | approved = draft

contentobject

= {}

{
  "status": "draft",
  "content": {}
}

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

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

Schema

localestringrequired

statusstringrequired

contentobjectrequired

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/templates/{id}/languages/{locale}

DELETEhttps://hermeticor.com/v1/templates/{id}/languages/{locale}

Parameters

idstringpathrequired

localestringpathrequired

Code samples

cURL

curl -X DELETE "https://hermeticor.com/v1/templates/{id}/languages/{locale}" \
  -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/templates/{id}/languages/{locale}

5XX Default Response

Same as 4XX · PUT /v1/templates/{id}/languages/{locale}

PUThttps://hermeticor.com/v1/assets/{id}/content

Replace the file behind an asset (multipart field "file"); the id and its references stay

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 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

Same as 4XX · PUT /v1/templates/{id}/languages/{locale}

5XX Default Response

Same as 4XX · PUT /v1/templates/{id}/languages/{locale}

GEThttps://hermeticor.com/v1/assets/{id}/signed-url

Parameters

expiresintegerquery

= 3600

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "url": "string",
  "expiresInSec": 0
}

Schema

urlstringrequired

expiresInSecintegerrequired

4XX Default Response

Same as 4XX · PUT /v1/templates/{id}/languages/{locale}

5XX Default Response

Same as 4XX · PUT /v1/templates/{id}/languages/{locale}

GEThttps://hermeticor.com/v1/assets/by-path

Look an asset up by /Folder/Sub/filename

Parameters

pathstringqueryrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/assets/by-path?path=<path>" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · PUT /v1/assets/{id}/content

4XX Default Response

Same as 4XX · PUT /v1/templates/{id}/languages/{locale}

5XX Default Response

Same as 4XX · PUT /v1/templates/{id}/languages/{locale}

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

Look an asset folder up by /Parent/Child

Parameters

pathstringqueryrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/asset-folders/by-path?path=<path>" \
  -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 · PUT /v1/templates/{id}/languages/{locale}

5XX Default Response

Same as 4XX · PUT /v1/templates/{id}/languages/{locale}

POSThttps://hermeticor.com/v1/brand-kits/scrape

Read name, logo, colours, fonts, address and social links from a public website (SSRF-guarded); suggestions only, nothing is saved

Request body

application/json

urlstringrequired

{
  "url": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/brand-kits/scrape" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "url": "string",
  "name": "string",
  "description": "string",
  "logoUrl": "string",
  "colors": {},
  "fonts": {},
  "postalAddress": "string",
  "socialLinks": [
    {
      "network": "string",
      "url": "string"
    }
  ]
}

Schema

urlstringrequired

namestringrequired

descriptionstringrequired

logoUrlstringrequired

colorsobjectrequired

fontsobjectrequired

postalAddressstringrequired

socialLinksobject[]required

Show child parameters

networkstringrequired

urlstringrequired

4XX Default Response

Same as 4XX · PUT /v1/templates/{id}/languages/{locale}

5XX Default Response

Same as 4XX · PUT /v1/templates/{id}/languages/{locale}

GEThttps://hermeticor.com/v1/brand-kits/{id}/history

Who changed this brand kit, when, and from what to what

Parameters

limitintegerquery

= 50

cursorstringquery

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "at": "2024-01-01T00:00:00Z",
      "action": "string",
      "actorId": "string",
      "changes": [
        {
          "field": "string",
          "from": {},
          "to": {}
        }
      ]
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

idstringrequired

atstringrequired

actionstringrequired

actorIdstringrequired

changesobject[]required

Show child parameters

fieldstringrequired

fromrequired

torequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · PUT /v1/templates/{id}/languages/{locale}

5XX Default Response

Same as 4XX · PUT /v1/templates/{id}/languages/{locale}

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

Daily sent, delivered, bounced, complained, opened and clicked counts for messages rendered from this template

Parameters

daysintegerquery

= 30

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "days": 0,
  "items": [
    {
      "day": "string",
      "sent": 0,
      "delivered": 0,
      "bounced": 0,
      "complained": 0,
      "opens": 0,
      "clicks": 0
    }
  ]
}

Schema

daysintegerrequired

itemsobject[]required

Show child parameters

daystringrequired

sentnumberrequired

deliverednumberrequired

bouncednumberrequired

complainednumberrequired

opensnumberrequired

clicksnumberrequired

4XX Default Response

Same as 4XX · PUT /v1/templates/{id}/languages/{locale}

5XX Default Response

Same as 4XX · PUT /v1/templates/{id}/languages/{locale}

Updated Nov 8, 2026

Was this page helpful?