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/templates/{id}/versions/{versionId}/approve

Parameters

idstringpathrequired

versionIdstringpathrequired

Request body

application/json

commentstring

{
  "comment": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/templates/{id}/versions/{versionId}/approve" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"comment":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "id": "string",
  "templateId": "string",
  "workspaceId": "string",
  "body": {
    "kind": "blocks",
    "doc": {
      "version": 1,
      "width": 600,
      "background": "string",
      "blocks": [
        {}
      ],
      "translations": {}
    }
  },
  "subject": "string",
  "preheader": "string",
  "fromNameOverride": "string",
  "textBody": "string",
  "approvalStatus": "none",
  "reviewComment": "string",
  "createdBy": "string",
  "createdAt": "2024-01-01T00:00:00Z",
  "approvedBy": "string",
  "approvedAt": "2024-01-01T00:00:00Z",
  "fromEmail": null,
  "replyTo": null,
  "cc": []
}

Schema

idstringrequired

templateIdstringrequired

workspaceIdstringrequired

bodyBodyVariant3 | BodyVariant4 | objectrequired

subjectstringrequired

preheaderstringrequired

fromNameOverridestringrequired

textBodystringrequired

approvalStatusstringrequired

none | pending | approved | rejected

reviewCommentstringrequired

createdBystringrequired

createdAtstringrequired

approvedBystringrequired

approvedAtstringrequired

fromEmailstringrequired

= null

replyTostringrequired

= null

ccstring[]required

= []

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/templates/{id}/versions/{versionId}/approve

POSThttps://hermeticor.com/v1/templates/{id}/versions/{versionId}/reject

Parameters

idstringpathrequired

versionIdstringpathrequired

Request body

application/json

commentstring

{
  "comment": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/templates/{id}/versions/{versionId}/reject" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"comment":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · POST /v1/templates/{id}/versions/{versionId}/approve

4XX Default Response

Same as 4XX · POST /v1/templates/{id}/versions/{versionId}/approve

5XX Default Response

Same as 4XX · POST /v1/templates/{id}/versions/{versionId}/approve

GEThttps://hermeticor.com/v1/templates/{id}/versions/{versionId}/link-check

Parameters

idstringpathrequired

versionIdstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "pending": true,
  "items": [
    {
      "url": "string",
      "status": 0,
      "error": "string",
      "checkedAt": "2024-01-01T00:00:00Z"
    }
  ]
}

Schema

pendingbooleanrequired

itemsItemsItem35[]required

Show child parameters

urlstringrequired

statusnumberrequired

errorstringrequired

checkedAtstringrequired

4XX Default Response

Same as 4XX · POST /v1/templates/{id}/versions/{versionId}/approve

5XX Default Response

Same as 4XX · POST /v1/templates/{id}/versions/{versionId}/approve

POSThttps://hermeticor.com/v1/templates/{id}/versions/{versionId}/link-check

Queue a HEAD check of every link in this version

Parameters

idstringpathrequired

versionIdstringpathrequired

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/templates/{id}/versions/{versionId}/link-check" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

202 Default Response

Same as 200 · GET /v1/templates/{id}/versions/{versionId}/link-check

4XX Default Response

Same as 4XX · POST /v1/templates/{id}/versions/{versionId}/approve

5XX Default Response

Same as 4XX · POST /v1/templates/{id}/versions/{versionId}/approve

GEThttps://hermeticor.com/v1/template-gallery

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "key": "string",
      "name": "string",
      "category": "string",
      "description": "string",
      "kind": "blocks"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

keystringrequired

namestringrequired

categorystringrequired

descriptionstringrequired

kindstringrequired

blocks | html | text | sms

nextCursorstringrequired

4XX Default Response

Same as 4XX · POST /v1/templates/{id}/versions/{versionId}/approve

5XX Default Response

Same as 4XX · POST /v1/templates/{id}/versions/{versionId}/approve

POSThttps://hermeticor.com/v1/template-gallery/{key}/instantiate

Parameters

keystringpathrequired

Request body

application/json

namestring

folderstring

{
  "name": "string",
  "folder": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/template-gallery/{key}/instantiate" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","folder":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "id": "string",
  "workspaceId": "string",
  "channel": "email",
  "name": "string",
  "kind": "blocks",
  "folder": "string",
  "tags": [
    "string"
  ],
  "currentVersionId": "string",
  "archived": true,
  "folderId": "string",
  "brandKitId": "string",
  "isDefault": false,
  "topicId": null,
  "createdBy": null,
  "createdAt": "2024-01-01T00:00:00Z",
  "updatedAt": "2024-01-01T00:00:00Z"
}

Schema

idstringrequired

workspaceIdstringrequired

channelstringrequired

email | sms | whatsapp | push | postcard

namestringrequired

kindstringrequired

blocks | html | text | sms

folderstringrequired

tagsstring[]required

currentVersionIdstringrequired

archivedbooleanrequired

folderIdstringrequired

brandKitIdstringrequired

isDefaultbooleanrequired

= false

topicIdstringrequired

= null

createdBystringrequired

= null

createdAtstringrequired

updatedAtstringrequired

4XX Default Response

Same as 4XX · POST /v1/templates/{id}/versions/{versionId}/approve

5XX Default Response

Same as 4XX · POST /v1/templates/{id}/versions/{versionId}/approve

GEThttps://hermeticor.com/v1/assets

Parameters

limitintegerquery

= 50

cursorstringquery

qstringquery

folderIdstringquery

tagstringquery

languagestringquery

typestringquery

accessstringquery

public_indexable | public_not_indexable | private

afterstringquery

beforestringquery

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "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"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsPostV1AssetsUploadsByIdCompleteResponse[]required

Show child parameters

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

nextCursorstringrequired

4XX Default Response

Same as 4XX · POST /v1/templates/{id}/versions/{versionId}/approve

5XX Default Response

Same as 4XX · POST /v1/templates/{id}/versions/{versionId}/approve

Next part

Updated Nov 8, 2026

Was this page helpful?