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>

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

Parameters

idstringpathrequired

Code samples

cURL

curl -X DELETE "https://hermeticor.com/v1/brand-kits/{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

Example

{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}

Schema

errorobjectrequired

Show child parameters

codestringrequired

messagestringrequired

detailsobject

5XX Default Response

Same as 4XX · DELETE /v1/brand-kits/{id}

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

Parameters

idstringpathrequired

Request body

application/json

namestring

logoAssetIdstring

logoUrlstring

colorsobject

Show child parameters

primarystring

textstring

backgroundstring

accentstring

fontsobject

Show child parameters

headingstring

bodystring

footerHtmlstring

postalAddressstring

customCssstring

layoutHtmlstring

isDefaultboolean

{
  "name": "string",
  "logoAssetId": "string",
  "logoUrl": "string",
  "colors": {
    "primary": "string",
    "text": "string",
    "background": "string",
    "accent": "string"
  },
  "fonts": {
    "heading": "string",
    "body": "string"
  },
  "footerHtml": "string",
  "postalAddress": "string",
  "customCss": "string",
  "layoutHtml": "string",
  "isDefault": true
}

Code samples

cURL

curl -X PATCH "https://hermeticor.com/v1/brand-kits/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","logoAssetId":"string","logoUrl":"string","colors":{"primary":"string","text":"string","background":"string","accent":"string"},"fonts":{"heading":"string","body":"string"},"footerHtml":"string","postalAddress":"string","customCss":"string","layoutHtml":"string","isDefault":true}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "name": "string",
  "logoAssetId": null,
  "logoUrl": null,
  "colors": {},
  "fonts": {},
  "footerHtml": null,
  "postalAddress": null,
  "customCss": null,
  "layoutHtml": null,
  "isDefault": false,
  "id": "string",
  "workspaceId": "string",
  "createdAt": "2024-01-01T00:00:00Z",
  "updatedAt": "2024-01-01T00:00:00Z"
}

Schema

namestringrequired

logoAssetIdstringrequired

= null

logoUrlstringrequired

= null

colorsobjectrequired

= {}

Show child parameters

primarystring

textstring

backgroundstring

accentstring

fontsobjectrequired

= {}

Show child parameters

headingstring

bodystring

footerHtmlstringrequired

= null

postalAddressstringrequired

= null

customCssstringrequired

= null

layoutHtmlstringrequired

= null

isDefaultbooleanrequired

= false

idstringrequired

workspaceIdstringrequired

createdAtstringrequired

updatedAtstringrequired

4XX Default Response

Same as 4XX · DELETE /v1/brand-kits/{id}

5XX Default Response

Same as 4XX · DELETE /v1/brand-kits/{id}

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

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "folders": [
    "string"
  ],
  "items": []
}

Schema

foldersstring[]required

itemsItemsItem34[]required

= []

Show child parameters

idstringrequired

kindstringrequired

template | asset

namestringrequired

parentIdstringrequired

itemCountnumberrequired

createdAtstringrequired

4XX Default Response

Same as 4XX · DELETE /v1/brand-kits/{id}

5XX Default Response

Same as 4XX · DELETE /v1/brand-kits/{id}

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

Request body

application/json

namestringrequired

parentIdstring

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

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/template-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

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 · DELETE /v1/brand-kits/{id}

5XX Default Response

Same as 4XX · DELETE /v1/brand-kits/{id}

POSThttps://hermeticor.com/v1/templates/{id}/clone

Parameters

idstringpathrequired

Request body

application/json

namestring

{
  "name": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/templates/{id}/clone" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"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 · DELETE /v1/brand-kits/{id}

5XX Default Response

Same as 4XX · DELETE /v1/brand-kits/{id}

GEThttps://hermeticor.com/v1/content-settings

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "approvalRequired": true,
  "campaignApprovalRequired": false,
  "uploadTypes": [
    "image",
    "pdf",
    "video"
  ],
  "defaultAssetAccess": "public_indexable"
}

Schema

approvalRequiredbooleanrequired

campaignApprovalRequiredbooleanrequired

= false

uploadTypesstring[]required

= ["image","pdf","video"]

defaultAssetAccessstringrequired

public_indexable | public_not_indexable | private = public_indexable

4XX Default Response

Same as 4XX · DELETE /v1/brand-kits/{id}

5XX Default Response

Same as 4XX · DELETE /v1/brand-kits/{id}

PATCHhttps://hermeticor.com/v1/content-settings

Request body

application/json

approvalRequiredboolean

campaignApprovalRequiredboolean

uploadTypesstring[]

defaultAssetAccessstring

public_indexable | public_not_indexable | private

{
  "approvalRequired": true,
  "campaignApprovalRequired": true,
  "uploadTypes": [
    "image"
  ],
  "defaultAssetAccess": "public_indexable"
}

Code samples

cURL

curl -X PATCH "https://hermeticor.com/v1/content-settings" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"approvalRequired":true,"campaignApprovalRequired":true,"uploadTypes":["image"],"defaultAssetAccess":"public_indexable"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · GET /v1/content-settings

4XX Default Response

Same as 4XX · DELETE /v1/brand-kits/{id}

5XX Default Response

Same as 4XX · DELETE /v1/brand-kits/{id}

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

Parameters

idstringpathrequired

versionIdstringpathrequired

Code samples

cURL

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

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

Same as 4XX · DELETE /v1/brand-kits/{id}

5XX Default Response

Same as 4XX · DELETE /v1/brand-kits/{id}

Next part

Updated Nov 8, 2026

Was this page helpful?