templates
POST
https://hermeticor.com /v1/saved-sections/{id}/clone Parameters
idstringpathrequiredRequest 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
namestringrequiredblocksschema0[]requiredidstringrequiredworkspaceIdstringrequiredcreatedAtstringrequiredupdatedAtstringrequired4XX Default Response
Example
{
"error": {
"code": "string",
"message": "string",
"details": {}
}
}Schema
errorobjectrequiredShow child parameters
codestringrequiredmessagestringrequireddetailsobjectPOST
https://hermeticor.com /v1/assets/import Import an image from a public URL (SSRF-guarded, content-sniffed, 5 MB cap)
Request body
application/json
urlstringrequiredfilenamestringfolderIdstring{
"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
idstringrequiredfilenamestringrequiredcontentTypestringrequiredbytesnumberrequiredwidthnumberrequiredheightnumberrequiredurlstringrequiredthumbUrlstringrequiredaltTextstringrequiredfolderIdstringrequiredlanguagestringrequiredtagsstring[]requiredscanStatusstringrequiredaccessstringrequiredcreatedAtstringrequiredGET
https://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
openTrackingbooleanrequiredclickTrackingbooleanrequiredsmsClickTrackingbooleanrequiredincludeMachineOpensbooleanrequiredutmAutoTagbooleanrequiredutmParamsobjectrequiredcustomParamsobjectrequiredclickAllowliststring[]requiredflowUtmParamsobjectrequiredflowCustomParamsobjectrequiredPATCH
https://hermeticor.com /v1/tracking-settings Request body
application/json
openTrackingbooleanclickTrackingbooleansmsClickTrackingbooleanincludeMachineOpensbooleanutmAutoTagbooleanutmParamsobjectcustomParamsobjectclickAllowliststring[]flowUtmParamsobjectflowCustomParamsobject{
"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
GET
https://hermeticor.com /v1/lists/{id}/optin-template Parameters
idstringpathrequiredCode 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
listIdstringrequiredsubjectstringrequiredhtmlstringrequiredtextstringrequiredisDefaultbooleanrequiredupdatedAtstringrequiredPUT
https://hermeticor.com /v1/lists/{id}/optin-template Parameters
idstringpathrequiredRequest body
application/json
subjectstringrequiredhtmlstringrequiredtextstring{
"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
DELETE
https://hermeticor.com /v1/lists/{id}/optin-template Parameters
idstringpathrequiredCode 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
okbooleanrequiredPOST
https://hermeticor.com /v1/lists/{id}/optin-template/preview Parameters
idstringpathrequiredRequest body
application/json
subjectstringhtmlstringtextstring{
"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
subjectstringrequiredhtmlstringrequiredtextstringrequiredGET
https://hermeticor.com /v1/template-tags Parameters
limitintegerqueryPage size; omitted returns the whole list
cursorstringqueryOpaque: the
nextCursor of the previous pageCode 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[]requiredShow child parameters
tagstringrequiredcountintegerrequirednextCursorstringrequiredUpdated