messages

Embed
Preview of the card
<a href="https://hermeticor.com/docs/ref-messages"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/8cc4dc4a-a73d-4367-99ad-799da94a79e7/social-card.svg?v=3e7ae33eec8b" alt="messages" width="600" height="315"></a>
GEThttps://hermeticor.com/v1/messages/export

CSV export of messages with every message-search filter (tag, sender, state, recipient, metadata, channel, dates)

Parameters

sortstringquery
createdAt | sentAt | status | destination
profileIdstringquery
statusstringquery
queued | deferred | blocked | sending | accepted | delivered | bounced | complained | failed | cancelled | needs_reconcile
sourceKindstringquery
campaign | workflow | sequence | api
sourceIdstringquery
qstringquery
objectTypestringquery
objectIdstringquery
orderstringquery
asc | desc = desc
tagstringquery
metadatastringquery
senderIdentityIdstringquery
templateIdstringquery
channelstringquery
email | sms | whatsapp | push | postcard
fromstringquery
tostringquery
varsstringquery
eventKindstringquery

Code samples

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

Responses

200 Default Response
{}
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/messages/export

GEThttps://hermeticor.com/v1/messages/events/export

CSV export of message events (delivered, bounced, opened, clicked...) for a date range

Parameters

fromstringquery
tostringquery
kindstringquery
jobIdstringquery
channelstringquery
email | sms | whatsapp | push | postcard

Code samples

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

Responses

200 Default Response
{}
4XX Default Response

Same as 4XX · GET /v1/messages/export

5XX Default Response

Same as 4XX · GET /v1/messages/export

POSThttps://hermeticor.com/v1/messages/{id}/reply

Record that the recipient replied to this message (once per message); feeds scoring, journeys and reports

Parameters

idstringpathrequired

Code samples

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

Responses

200 Default Response
Example
{
  "recorded": true
}
Schema
recordedbooleanrequired
4XX Default Response

Same as 4XX · GET /v1/messages/export

5XX Default Response

Same as 4XX · GET /v1/messages/export

POSThttps://hermeticor.com/v1/messages/{id}/unsubscribe

Unsubscribe the recipient of this message from the channel and purpose it was sent on (consent revoked, address suppressed)

Parameters

idstringpathrequired

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/messages/{id}/unsubscribe" \
  -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 · GET /v1/messages/export

5XX Default Response

Same as 4XX · GET /v1/messages/export

GEThttps://hermeticor.com/v1/messages/{id}/preview

A message re-rendered for its recipient (any purpose and channel; stored content is transactional email only). Unsubscribe links stay placeholders

Parameters

idstringpathrequired

Code samples

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

Responses

200 Default Response
Example
{
  "title": "string",
  "html": "string"
}
Schema
titlestringrequired
htmlstringrequired
4XX Default Response

Same as 4XX · GET /v1/messages/export

5XX Default Response

Same as 4XX · GET /v1/messages/export

Updated