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>

PATCHhttps://hermeticor.com/v1/snippets/{id}

Parameters

idstringpathrequired

Request body

application/json

bodystringrequired

{
  "body": "string"
}

Code samples

cURL

curl -X PATCH "https://hermeticor.com/v1/snippets/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"body":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "id": "string",
  "workspaceId": "string",
  "key": "string",
  "channel": "email",
  "body": "string",
  "locked": true,
  "createdAt": "2024-01-01T00:00:00Z",
  "updatedAt": "2024-01-01T00:00:00Z"
}

Schema

idstringrequired

workspaceIdstringrequired

keystringrequired

channelstringrequired

email | sms | whatsapp | push | postcard

bodystringrequired

lockedbooleanrequired

createdAtstringrequired

updatedAtstringrequired

4XX Default Response

Example

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

Schema

errorobjectrequired

Show child parameters

codestringrequired

messagestringrequired

detailsobject

5XX Default Response

Same as 4XX · PATCH /v1/snippets/{id}

PATCHhttps://hermeticor.com/v1/snippets/{id}/lock

Lock: blocks edits and deletes until unlocked

Parameters

idstringpathrequired

Code samples

cURL

curl -X PATCH "https://hermeticor.com/v1/snippets/{id}/lock" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · PATCH /v1/snippets/{id}

4XX Default Response

Same as 4XX · PATCH /v1/snippets/{id}

5XX Default Response

Same as 4XX · PATCH /v1/snippets/{id}

PATCHhttps://hermeticor.com/v1/snippets/{id}/unlock

Parameters

idstringpathrequired

Code samples

cURL

curl -X PATCH "https://hermeticor.com/v1/snippets/{id}/unlock" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · PATCH /v1/snippets/{id}

4XX Default Response

Same as 4XX · PATCH /v1/snippets/{id}

5XX Default Response

Same as 4XX · PATCH /v1/snippets/{id}

POSThttps://hermeticor.com/v1/snippets/bulk-delete

Delete up to 100 snippets; locked ones are skipped

Request body

application/json

idsstring[]required

{
  "ids": [
    "string"
  ]
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/snippets/bulk-delete" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"ids":["string"]}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "deleted": 0,
  "skippedLocked": 0
}

Schema

deletedintegerrequired

skippedLockedintegerrequired

4XX Default Response

Same as 4XX · PATCH /v1/snippets/{id}

5XX Default Response

Same as 4XX · PATCH /v1/snippets/{id}

GEThttps://hermeticor.com/v1/brand-kits

Parameters

limitintegerquery

= 50

cursorstringquery

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

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

Schema

itemsItemsItem33[]required

Show child parameters

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

nextCursorstringrequired

4XX Default Response

Same as 4XX · PATCH /v1/snippets/{id}

5XX Default Response

Same as 4XX · PATCH /v1/snippets/{id}

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

Request body

application/json

namestringrequired

logoAssetIdstring

= null

logoUrlstring

= null

colorsobject

= {}

Show child parameters

primarystring

textstring

backgroundstring

accentstring

fontsobject

= {}

Show child parameters

headingstring

bodystring

footerHtmlstring

= null

postalAddressstring

= null

customCssstring

= null

layoutHtmlstring

= null

isDefaultboolean

= false

{
  "name": "string",
  "logoAssetId": null,
  "logoUrl": null,
  "colors": {},
  "fonts": {},
  "footerHtml": null,
  "postalAddress": null,
  "customCss": null,
  "layoutHtml": null,
  "isDefault": false
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/brand-kits" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","logoAssetId":null,"logoUrl":null,"colors":{},"fonts":{},"footerHtml":null,"postalAddress":null,"customCss":null,"layoutHtml":null,"isDefault":false}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 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 · PATCH /v1/snippets/{id}

5XX Default Response

Same as 4XX · PATCH /v1/snippets/{id}

GEThttps://hermeticor.com/v1/brand-kits/primary

The default brand kit

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/brand-kits

4XX Default Response

Same as 4XX · PATCH /v1/snippets/{id}

5XX Default Response

Same as 4XX · PATCH /v1/snippets/{id}

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

Make this the default brand kit

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/brand-kits

4XX Default Response

Same as 4XX · PATCH /v1/snippets/{id}

5XX Default Response

Same as 4XX · PATCH /v1/snippets/{id}

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

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/brand-kits

4XX Default Response

Same as 4XX · PATCH /v1/snippets/{id}

5XX Default Response

Same as 4XX · PATCH /v1/snippets/{id}

Next part

Updated Nov 8, 2026

Was this page helpful?