transactional

Embed
Preview of the card
<a href="https://hermeticor.com/docs/ref-transactional"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/3cb76e64-a1f1-4ede-8c35-73d2172e4bf2/social-card.svg?v=3e7ae33eec8b" alt="transactional" width="600" height="315"></a>
PUThttps://hermeticor.com/v1/transactional/definitions/{id}/contents/{contentId}

Parameters

idstringpathrequired
contentIdstringpathrequired

Request body

application/json
statusstring
draft | approved = approved
contentobjectrequired
{
  "status": "approved",
  "content": {}
}

Code samples

cURL
curl -X PUT "https://hermeticor.com/v1/transactional/definitions/{id}/contents/{contentId}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"status":"approved","content":{}}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "id": "string",
  "locale": "string",
  "status": "string",
  "content": {}
}
Schema
idstringrequired
localestringrequired
statusstringrequired
contentobjectrequired
4XX Default Response
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
detailsobject
5XX Default Response

Same as 4XX · PUT /v1/transactional/definitions/{id}/contents/{contentId}

GEThttps://hermeticor.com/v1/account/summary

Sent, delivered, bounced, complained, opens and clicks for today and the last 7, 30, 60 and 90 days, with bounce and complaint rates

Code samples

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

Responses

200 Default Response
Example
{
  "workspace": {
    "id": "string",
    "name": "string"
  },
  "stats": {}
}
Schema
workspaceobjectrequired
Show child parameters
idstringrequired
namestringrequired
statsobjectrequired
4XX Default Response

Same as 4XX · PUT /v1/transactional/definitions/{id}/contents/{contentId}

5XX Default Response

Same as 4XX · PUT /v1/transactional/definitions/{id}/contents/{contentId}

GEThttps://hermeticor.com/v1/transactional/metadata-fields

Declared metadata keys shown as message-log columns, each with an optional view template ({{ value }})

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

Responses

200 Default Response
Example
{
  "items": [
    {
      "id": "string",
      "name": "string",
      "viewTemplate": "string",
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}
Schema
itemsItemsItem237[]required
Show child parameters
idstringrequired
namestringrequired
viewTemplatestringrequired
createdAtstringrequired
nextCursorstringrequired
4XX Default Response

Same as 4XX · PUT /v1/transactional/definitions/{id}/contents/{contentId}

5XX Default Response

Same as 4XX · PUT /v1/transactional/definitions/{id}/contents/{contentId}

POSThttps://hermeticor.com/v1/transactional/metadata-fields

Request body

application/json
namestringrequired
viewTemplatestring
{
  "name": "string",
  "viewTemplate": "string"
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/transactional/metadata-fields" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","viewTemplate":"string"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "id": "string",
  "name": "string",
  "viewTemplate": "string",
  "createdAt": "2024-01-01T00:00:00Z"
}
Schema
idstringrequired
namestringrequired
viewTemplatestringrequired
createdAtstringrequired
4XX Default Response

Same as 4XX · PUT /v1/transactional/definitions/{id}/contents/{contentId}

5XX Default Response

Same as 4XX · PUT /v1/transactional/definitions/{id}/contents/{contentId}

DELETEhttps://hermeticor.com/v1/transactional/metadata-fields/{name}

Stop showing a metadata key in the log; messages keep their metadata

Parameters

namestringpathrequired

Code samples

cURL
curl -X DELETE "https://hermeticor.com/v1/transactional/metadata-fields/{name}" \
  -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 · PUT /v1/transactional/definitions/{id}/contents/{contentId}

5XX Default Response

Same as 4XX · PUT /v1/transactional/definitions/{id}/contents/{contentId}

PATCHhttps://hermeticor.com/v1/transactional/metadata-fields/{name}

Parameters

namestringpathrequired

Request body

application/json
viewTemplatestringrequired
{
  "viewTemplate": "string"
}

Code samples

cURL
curl -X PATCH "https://hermeticor.com/v1/transactional/metadata-fields/{name}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"viewTemplate":"string"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 200 · POST /v1/transactional/metadata-fields

4XX Default Response

Same as 4XX · PUT /v1/transactional/definitions/{id}/contents/{contentId}

5XX Default Response

Same as 4XX · PUT /v1/transactional/definitions/{id}/contents/{contentId}

PUThttps://hermeticor.com/v1/send-options/{sourceKind}/{sourceId}/behaviour

Strict Liquid (null = default strict) and send-from-contact-owner for a campaign, journey or sequence; other send options are untouched

Parameters

sourceKindstringpathrequired
campaign | workflow | sequence
sourceIdstringpathrequired

Request body

application/json
strictLiquidboolean
fromOwnerboolean
{
  "strictLiquid": true,
  "fromOwner": true
}

Code samples

cURL
curl -X PUT "https://hermeticor.com/v1/send-options/{sourceKind}/{sourceId}/behaviour" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"strictLiquid":true,"fromOwner":true}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "strictLiquid": true,
  "fromOwner": true
}
Schema
strictLiquidbooleanrequired
fromOwnerbooleanrequired
4XX Default Response

Same as 4XX · PUT /v1/transactional/definitions/{id}/contents/{contentId}

5XX Default Response

Same as 4XX · PUT /v1/transactional/definitions/{id}/contents/{contentId}

Updated