templates

Embed
Preview of the card
<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/saved-sections/{id}/clone

Parameters

idstringpathrequired

Request body

application/json
namestring
{
  "name": "string"
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/saved-sections/{id}/clone" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

201 Default Response
Example
{
  "name": "string",
  "blocks": [
    {}
  ],
  "id": "string",
  "workspaceId": "string",
  "createdAt": "2024-01-01T00:00:00Z",
  "updatedAt": "2024-01-01T00:00:00Z"
}
Schema
namestringrequired
blocksschema0[]required
idstringrequired
workspaceIdstringrequired
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 · POST /v1/saved-sections/{id}/clone

POSThttps://hermeticor.com/v1/assets/import

Import an image from a public URL (SSRF-guarded, content-sniffed, 5 MB cap)

Request body

application/json
urlstringrequired
filenamestring
folderIdstring
{
  "url": "string",
  "filename": "string",
  "folderId": "string"
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/assets/import" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"string","filename":"string","folderId":"string"}'
TypeScript
Python
Go
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

Same as 4XX · POST /v1/saved-sections/{id}/clone

5XX Default Response

Same as 4XX · POST /v1/saved-sections/{id}/clone

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

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/tracking-settings" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "openTracking": true,
  "clickTracking": true,
  "smsClickTracking": true,
  "includeMachineOpens": true,
  "utmAutoTag": true,
  "utmParams": {},
  "customParams": {},
  "clickAllowlist": [],
  "flowUtmParams": {},
  "flowCustomParams": {}
}
Schema
openTrackingbooleanrequired
clickTrackingbooleanrequired
smsClickTrackingbooleanrequired
includeMachineOpensbooleanrequired
utmAutoTagbooleanrequired
utmParamsobjectrequired
customParamsobjectrequired
clickAllowliststring[]required
= []
flowUtmParamsobjectrequired
= {}
flowCustomParamsobjectrequired
= {}
4XX Default Response

Same as 4XX · POST /v1/saved-sections/{id}/clone

5XX Default Response

Same as 4XX · POST /v1/saved-sections/{id}/clone

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

Request body

application/json
openTrackingboolean
clickTrackingboolean
smsClickTrackingboolean
includeMachineOpensboolean
utmAutoTagboolean
utmParamsobject
customParamsobject
clickAllowliststring[]
flowUtmParamsobject
flowCustomParamsobject
{
  "openTracking": true,
  "clickTracking": true,
  "smsClickTracking": true,
  "includeMachineOpens": true,
  "utmAutoTag": true,
  "utmParams": {},
  "customParams": {},
  "clickAllowlist": [
    "string"
  ],
  "flowUtmParams": {},
  "flowCustomParams": {}
}

Code samples

cURL
curl -X PATCH "https://hermeticor.com/v1/tracking-settings" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"openTracking":true,"clickTracking":true,"smsClickTracking":true,"includeMachineOpens":true,"utmAutoTag":true,"utmParams":{},"customParams":{},"clickAllowlist":["string"],"flowUtmParams":{},"flowCustomParams":{}}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 200 · GET /v1/tracking-settings

4XX Default Response

Same as 4XX · POST /v1/saved-sections/{id}/clone

5XX Default Response

Same as 4XX · POST /v1/saved-sections/{id}/clone

GEThttps://hermeticor.com/v1/lists/{id}/optin-template

Parameters

idstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/lists/{id}/optin-template" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "listId": "string",
  "subject": "string",
  "html": "string",
  "text": "string",
  "isDefault": true,
  "updatedAt": "2024-01-01T00:00:00Z"
}
Schema
listIdstringrequired
subjectstringrequired
htmlstringrequired
textstringrequired
isDefaultbooleanrequired
updatedAtstringrequired
4XX Default Response

Same as 4XX · POST /v1/saved-sections/{id}/clone

5XX Default Response

Same as 4XX · POST /v1/saved-sections/{id}/clone

PUThttps://hermeticor.com/v1/lists/{id}/optin-template

Parameters

idstringpathrequired

Request body

application/json
subjectstringrequired
htmlstringrequired
textstring
{
  "subject": "string",
  "html": "string",
  "text": "string"
}

Code samples

cURL
curl -X PUT "https://hermeticor.com/v1/lists/{id}/optin-template" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"subject":"string","html":"string","text":"string"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 200 · GET /v1/lists/{id}/optin-template

4XX Default Response

Same as 4XX · POST /v1/saved-sections/{id}/clone

5XX Default Response

Same as 4XX · POST /v1/saved-sections/{id}/clone

DELETEhttps://hermeticor.com/v1/lists/{id}/optin-template

Parameters

idstringpathrequired

Code samples

cURL
curl -X DELETE "https://hermeticor.com/v1/lists/{id}/optin-template" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "ok": true
}
Schema
okbooleanrequired
true
4XX Default Response

Same as 4XX · POST /v1/saved-sections/{id}/clone

5XX Default Response

Same as 4XX · POST /v1/saved-sections/{id}/clone

POSThttps://hermeticor.com/v1/lists/{id}/optin-template/preview

Parameters

idstringpathrequired

Request body

application/json
subjectstring
htmlstring
textstring
{
  "subject": "string",
  "html": "string",
  "text": "string"
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/lists/{id}/optin-template/preview" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"subject":"string","html":"string","text":"string"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "subject": "string",
  "html": "string",
  "text": "string"
}
Schema
subjectstringrequired
htmlstringrequired
textstringrequired
4XX Default Response

Same as 4XX · POST /v1/saved-sections/{id}/clone

5XX Default Response

Same as 4XX · POST /v1/saved-sections/{id}/clone

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

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-tags" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "items": [
    {
      "tag": "string",
      "count": 0
    }
  ],
  "nextCursor": "string"
}
Schema
itemsobject[]required
Show child parameters
tagstringrequired
countintegerrequired
nextCursorstringrequired
4XX Default Response

Same as 4XX · POST /v1/saved-sections/{id}/clone

5XX Default Response

Same as 4XX · POST /v1/saved-sections/{id}/clone

Updated