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>
GEThttps://hermeticor.com/v1/templates/{id}/usage

Campaigns and workflows that use this template

Parameters

idstringpathrequired

Code samples

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

Responses

200 Default Response
Example
{
  "campaigns": [
    {
      "id": "string",
      "name": "string",
      "status": "string"
    }
  ],
  "workflows": [
    {
      "id": "string",
      "name": "string",
      "status": "string"
    }
  ],
  "blocking": true
}
Schema
campaignsCampaignsItem[]required
Show child parameters
idstringrequired
namestringrequired
statusstringrequired
workflowsCampaignsItem[]required
Show child parameters
idstringrequired
namestringrequired
statusstringrequired
blockingbooleanrequired
4XX Default Response
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
detailsobject
5XX Default Response

Same as 4XX · GET /v1/templates/{id}/usage

GEThttps://hermeticor.com/v1/templates/{id}/publish-status

Live version, unpublished changes and versions waiting for approval

Parameters

idstringpathrequired

Code samples

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

Responses

200 Default Response
Example
{
  "templateId": "string",
  "currentVersionId": "string",
  "liveVersionId": "string",
  "approvalRequired": true,
  "unpublishedChanges": true,
  "pendingVersionIds": [
    "string"
  ]
}
Schema
templateIdstringrequired
currentVersionIdstringrequired
liveVersionIdstringrequired
approvalRequiredbooleanrequired
unpublishedChangesbooleanrequired
pendingVersionIdsstring[]required
4XX Default Response

Same as 4XX · GET /v1/templates/{id}/usage

5XX Default Response

Same as 4XX · GET /v1/templates/{id}/usage

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

Make the version current; with approvals on, an unapproved one is submitted instead

Parameters

idstringpathrequired
versionIdstringpathrequired

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/templates/{id}/versions/{versionId}/publish" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "status": "published",
  "version": {
    "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
statusstringrequired
published | pending_approval
versionobjectrequired
Show child parameters
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 · GET /v1/templates/{id}/usage

5XX Default Response

Same as 4XX · GET /v1/templates/{id}/usage

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

Save a copy of an old version as the newest version

Parameters

idstringpathrequired
versionIdstringpathrequired

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/templates/{id}/versions/{versionId}/restore" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

201 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 · GET /v1/templates/{id}/usage

5XX Default Response

Same as 4XX · GET /v1/templates/{id}/usage

GEThttps://hermeticor.com/v1/templates/{id}/versions/{versionId}/regions

Editable regions: block ids, or mc:edit names in HTML

Parameters

limitintegerquery
Page size; omitted returns the whole list
cursorstringquery
Opaque: the nextCursor of the previous page
idstringpathrequired
versionIdstringpathrequired

Code samples

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

Responses

200 Default Response
Example
{
  "items": [
    {
      "id": "string",
      "type": "string"
    }
  ],
  "nextCursor": "string"
}
Schema
itemsobject[]required
Show child parameters
idstringrequired
typestringrequired
nextCursorstringrequired
4XX Default Response

Same as 4XX · GET /v1/templates/{id}/usage

5XX Default Response

Same as 4XX · GET /v1/templates/{id}/usage

GEThttps://hermeticor.com/v1/templates/{id}/languages

Parameters

limitintegerquery
Page size; omitted returns the whole list
cursorstringquery
Opaque: the nextCursor of the previous page
idstringpathrequired

Code samples

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

Responses

200 Default Response
Example
{
  "items": [
    {
      "locale": "string",
      "status": "string",
      "content": {}
    }
  ],
  "nextCursor": "string"
}
Schema
itemsItemsItem40[]required
Show child parameters
localestringrequired
statusstringrequired
contentobjectrequired
nextCursorstringrequired
4XX Default Response

Same as 4XX · GET /v1/templates/{id}/usage

5XX Default Response

Same as 4XX · GET /v1/templates/{id}/usage

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

Parameters

idstringpathrequired

Request body

application/json
statusstring
draft | approved = draft
contentobject
= {}
localestringrequired
{
  "status": "draft",
  "content": {},
  "locale": "string"
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/templates/{id}/languages" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"status":"draft","content":{},"locale":"string"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

201 Default Response
Example
{
  "locale": "string",
  "status": "string",
  "content": {}
}
Schema
localestringrequired
statusstringrequired
contentobjectrequired
4XX Default Response

Same as 4XX · GET /v1/templates/{id}/usage

5XX Default Response

Same as 4XX · GET /v1/templates/{id}/usage

GEThttps://hermeticor.com/v1/templates/{id}/languages/{locale}

Parameters

idstringpathrequired
localestringpathrequired

Code samples

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

Responses

200 Default Response

Same as 201 · POST /v1/templates/{id}/languages

4XX Default Response

Same as 4XX · GET /v1/templates/{id}/usage

5XX Default Response

Same as 4XX · GET /v1/templates/{id}/usage

Updated