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/uploads/{id}/complete

Assemble the chunks into a library asset (same checks and limits as a normal upload)

Parameters

idstringpathrequired

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/assets/uploads/{id}/complete" \
  -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/uploads/{id}/complete

POSThttps://hermeticor.com/v1/markdown/preview

Render Markdown the way a markdown template compiles it (live editor preview)

Request body

application/json

sourcestringrequired

{
  "source": "string"
}

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "html": "string"
}

Schema

htmlstringrequired

4XX Default Response

Same as 4XX · POST /v1/assets/uploads/{id}/complete

5XX Default Response

Same as 4XX · POST /v1/assets/uploads/{id}/complete

GEThttps://hermeticor.com/v1/templates

Filter by channel, folder, tag, text, creator (`createdBy=me`), format and creation date; sort newest, oldest, name or updated

Parameters

limitintegerquery

= 50

cursorstringquery

channelstringquery

email | sms | whatsapp | push | postcard

folderstringquery

folderIdstringquery

tagstringquery

qstringquery

archivedstringquery

true | false

createdBystringquery

kindstringquery

blocks | html | text | sms

createdAfterstringquery

createdBeforestringquery

sortstringquery

newest | oldest | name | name_desc | updated = newest

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

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

Schema

itemsItemsItem30[]required

Show child parameters

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

nextCursorstringrequired

4XX Default Response

Same as 4XX · POST /v1/assets/uploads/{id}/complete

5XX Default Response

Same as 4XX · POST /v1/assets/uploads/{id}/complete

POSThttps://hermeticor.com/v1/templates

Request body

application/json

namestringrequired

kindstringrequired

blocks | html | text | sms

channelstring

push

folderstring

folderIdstring

tagsstring[]

= []

versionobject

Show child parameters

bodyBodyVariant | BodyVariant2 | objectrequired

subjectstring

= null

preheaderstring

= null

fromNameOverridestring

= null

textBodystring

= null

fromEmailstring

replyTostring

ccstring[]

{
  "name": "string",
  "kind": "blocks",
  "channel": "push",
  "folder": "string",
  "folderId": "string",
  "tags": [],
  "version": {
    "body": {
      "kind": "blocks",
      "doc": {
        "version": 1,
        "width": 600,
        "background": "string",
        "blocks": [
          {}
        ],
        "translations": {}
      }
    },
    "subject": null,
    "preheader": null,
    "fromNameOverride": null,
    "textBody": null,
    "fromEmail": "string",
    "replyTo": "string",
    "cc": [
      "string"
    ]
  }
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/templates" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","kind":"blocks","channel":"push","folder":"string","folderId":"string","tags":[],"version":{"body":{"kind":"blocks","doc":{"version":1,"width":600,"background":"string","blocks":[{}],"translations":{}}},"subject":null,"preheader":null,"fromNameOverride":null,"textBody":null,"fromEmail":"string","replyTo":"string","cc":["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/assets/uploads/{id}/complete

5XX Default Response

Same as 4XX · POST /v1/assets/uploads/{id}/complete

POSThttps://hermeticor.com/v1/templates/bulk-update

Move, tag, re-brand, set the topic of or archive up to 100 templates; each is applied or refused on its own

Request body

application/json

idsstring[]required

patchobjectrequired

Show child parameters

folderIdstring

archivedboolean

brandKitIdstring

topicIdstring

tagsstring[]

addTagsstring[]

removeTagsstring[]

{
  "ids": [
    "string"
  ],
  "patch": {
    "folderId": "string",
    "archived": true,
    "brandKitId": "string",
    "topicId": "string",
    "tags": [
      "string"
    ],
    "addTags": [
      "string"
    ],
    "removeTags": [
      "string"
    ]
  }
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/templates/bulk-update" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"ids":["string"],"patch":{"folderId":"string","archived":true,"brandKitId":"string","topicId":"string","tags":["string"],"addTags":["string"],"removeTags":["string"]}}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "updated": 0,
  "failed": [
    {
      "id": "string",
      "reason": "string"
    }
  ]
}

Schema

updatedintegerrequired

failedFailedItem[]required

Show child parameters

idstringrequired

reasonstringrequired

4XX Default Response

Same as 4XX · POST /v1/assets/uploads/{id}/complete

5XX Default Response

Same as 4XX · POST /v1/assets/uploads/{id}/complete

Next part

Updated Nov 8, 2026

Was this page helpful?