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>
DELETEhttps://hermeticor.com/v1/asset-folders/{id}

Parameters

idstringpathrequired

Code samples

cURL
curl -X DELETE "https://hermeticor.com/v1/asset-folders/{id}" \
  -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
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
detailsobject
5XX Default Response

Same as 4XX · DELETE /v1/asset-folders/{id}

PATCHhttps://hermeticor.com/v1/asset-folders/{id}

Parameters

idstringpathrequired

Request body

application/json
namestring
parentIdstring
{
  "name": "string",
  "parentId": "string"
}

Code samples

cURL
curl -X PATCH "https://hermeticor.com/v1/asset-folders/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","parentId":"string"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 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/asset-folders/{id}

5XX Default Response

Same as 4XX · DELETE /v1/asset-folders/{id}

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

Parameters

limitintegerquery
= 50
cursorstringquery
kindstringquery
logo | color | font | button | social_group | email_default | company | competitor
idstringpathrequired

Code samples

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

Responses

200 Default Response
Example
{
  "items": [
    {
      "id": "string",
      "kitId": "string",
      "kind": "logo",
      "name": "string",
      "data": {},
      "createdAt": "2024-01-01T00:00:00Z",
      "updatedAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}
Schema
itemsItemsItem38[]required
Show child parameters
idstringrequired
kitIdstringrequired
kindstringrequired
logo | color | font | button | social_group | email_default | company | competitor
namestringrequired
dataobjectrequired
createdAtstringrequired
updatedAtstringrequired
nextCursorstringrequired
4XX Default Response

Same as 4XX · DELETE /v1/asset-folders/{id}

5XX Default Response

Same as 4XX · DELETE /v1/asset-folders/{id}

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

Parameters

idstringpathrequired

Request body

application/json
kindstringrequired
logo | color | font | button | social_group | email_default | company | competitor
namestringrequired
dataobject
= {}
{
  "kind": "logo",
  "name": "string",
  "data": {}
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/brand-kits/{id}/items" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"kind":"logo","name":"string","data":{}}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

201 Default Response
Example
{
  "id": "string",
  "kitId": "string",
  "kind": "logo",
  "name": "string",
  "data": {},
  "createdAt": "2024-01-01T00:00:00Z",
  "updatedAt": "2024-01-01T00:00:00Z"
}
Schema
idstringrequired
kitIdstringrequired
kindstringrequired
logo | color | font | button | social_group | email_default | company | competitor
namestringrequired
dataobjectrequired
createdAtstringrequired
updatedAtstringrequired
4XX Default Response

Same as 4XX · DELETE /v1/asset-folders/{id}

5XX Default Response

Same as 4XX · DELETE /v1/asset-folders/{id}

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

Parameters

idstringpathrequired

Code samples

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

Responses

200 Default Response

Same as 201 · POST /v1/brand-kits/{id}/items

4XX Default Response

Same as 4XX · DELETE /v1/asset-folders/{id}

5XX Default Response

Same as 4XX · DELETE /v1/asset-folders/{id}

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

Parameters

idstringpathrequired

Code samples

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

Responses

200 Default Response

Same as 200 · DELETE /v1/asset-folders/{id}

4XX Default Response

Same as 4XX · DELETE /v1/asset-folders/{id}

5XX Default Response

Same as 4XX · DELETE /v1/asset-folders/{id}

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

Parameters

idstringpathrequired

Request body

application/json
namestring
dataobject
{
  "name": "string",
  "data": {}
}

Code samples

cURL
curl -X PATCH "https://hermeticor.com/v1/brand-items/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","data":{}}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 201 · POST /v1/brand-kits/{id}/items

4XX Default Response

Same as 4XX · DELETE /v1/asset-folders/{id}

5XX Default Response

Same as 4XX · DELETE /v1/asset-folders/{id}

GEThttps://hermeticor.com/v1/translations

Parameters

limitintegerquery
= 50
cursorstringquery
resourceTypestringquery
template | saved_section | form | sms | workflow_message | campaign_variant
resourceIdstringquery
localestringquery
statusstringquery
draft | approved
templateIdstringquery

Code samples

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

Responses

200 Default Response
Example
{
  "items": [
    {
      "resourceType": "template",
      "resourceId": "string",
      "locale": "string",
      "status": "draft",
      "content": {},
      "id": "string",
      "createdAt": "2024-01-01T00:00:00Z",
      "updatedAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}
Schema
itemsItemsItem39[]required
Show child parameters
resourceTypestringrequired
template | saved_section | form | sms | workflow_message | campaign_variant
resourceIdstringrequired
localestringrequired
statusstringrequired
draft | approved = draft
contentobjectrequired
= {}
idstringrequired
createdAtstringrequired
updatedAtstringrequired
nextCursorstringrequired
4XX Default Response

Same as 4XX · DELETE /v1/asset-folders/{id}

5XX Default Response

Same as 4XX · DELETE /v1/asset-folders/{id}

POSThttps://hermeticor.com/v1/translations

Request body

application/json
resourceTypestringrequired
template | saved_section | form | sms | workflow_message | campaign_variant
resourceIdstringrequired
localestringrequired
statusstring
draft | approved = draft
contentobject
= {}
{
  "resourceType": "template",
  "resourceId": "string",
  "locale": "string",
  "status": "draft",
  "content": {}
}

Code samples

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

Responses

201 Default Response
Example
{
  "resourceType": "template",
  "resourceId": "string",
  "locale": "string",
  "status": "draft",
  "content": {},
  "id": "string",
  "createdAt": "2024-01-01T00:00:00Z",
  "updatedAt": "2024-01-01T00:00:00Z"
}
Schema
resourceTypestringrequired
template | saved_section | form | sms | workflow_message | campaign_variant
resourceIdstringrequired
localestringrequired
statusstringrequired
draft | approved = draft
contentobjectrequired
= {}
idstringrequired
createdAtstringrequired
updatedAtstringrequired
4XX Default Response

Same as 4XX · DELETE /v1/asset-folders/{id}

5XX Default Response

Same as 4XX · DELETE /v1/asset-folders/{id}

Updated