campaigns

Embed
Preview of the card
<a href="https://hermeticor.com/docs/ref-campaigns"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/7b5e5778-2701-4b75-820c-3417186ab185/social-card.svg?v=3e7ae33eec8b" alt="campaigns" width="600" height="315"></a>
PUThttps://hermeticor.com/v1/campaigns/{id}/postcard

Save the postcard design (6x4 or 9x6, HTML front and back with merge tags)

Parameters

idstringpathrequired

Request body

application/json
sizestring
6x4 | 9x6 = 6x4
frontstringrequired
backstringrequired
{
  "size": "6x4",
  "front": "string",
  "back": "string"
}

Code samples

cURL
curl -X PUT "https://hermeticor.com/v1/campaigns/{id}/postcard" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"size":"6x4","front":"string","back":"string"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "messageId": "string",
  "design": {
    "size": "6x4",
    "front": "string",
    "back": "string"
  }
}
Schema
messageIdstringrequired
designobjectrequired
Show child parameters
sizestringrequired
6x4 | 9x6 = 6x4
frontstringrequired
backstringrequired
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/campaigns/{id}/postcard

POSThttps://hermeticor.com/v1/campaigns/{id}/postcard/proof

Render both sides for one contact (or sample data) and show the address it would go to

Parameters

idstringpathrequired

Request body

application/json
profileIdstring
designobject
Show child parameters
sizestring
6x4 | 9x6 = 6x4
frontstringrequired
backstringrequired
{
  "profileId": "string",
  "design": {
    "size": "6x4",
    "front": "string",
    "back": "string"
  }
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/campaigns/{id}/postcard/proof" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"profileId":"string","design":{"size":"6x4","front":"string","back":"string"}}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "size": "6x4",
  "front": "string",
  "back": "string",
  "address": {
    "name": "string",
    "line1": "string",
    "line2": "string",
    "city": "string",
    "region": "string",
    "postalCode": "string",
    "country": "string"
  },
  "skipReason": "string",
  "warnings": [
    "string"
  ]
}
Schema
sizestringrequired
6x4 | 9x6
frontstringrequired
backstringrequired
addressobjectrequired
Show child parameters
namestringrequired
line1stringrequired
line2stringrequired
citystringrequired
regionstringrequired
postalCodestringrequired
countrystringrequired
skipReasonstringrequired
warningsstring[]required
4XX Default Response

Same as 4XX · PUT /v1/campaigns/{id}/postcard

5XX Default Response

Same as 4XX · PUT /v1/campaigns/{id}/postcard

GEThttps://hermeticor.com/v1/campaigns/{id}/postcard/report

Parameters

idstringpathrequired

Code samples

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

Responses

200 Default Response
Example
{
  "campaignId": "string",
  "byStatus": {},
  "skipped": [
    {
      "reason": "string",
      "count": 0
    }
  ]
}
Schema
campaignIdstringrequired
byStatusobjectrequired
skippedBlockReasonsItem[]required
Show child parameters
reasonstringrequired
countintegerrequired
4XX Default Response

Same as 4XX · PUT /v1/campaigns/{id}/postcard

5XX Default Response

Same as 4XX · PUT /v1/campaigns/{id}/postcard

GEThttps://hermeticor.com/v1/reports

Sent campaigns with opens, clicks, bounces, unsubscribes, complaints and rates; filter by channel, type and send time

Parameters

limitintegerquery
= 50
cursorstringquery
channelstringquery
email | sms | whatsapp | push | postcard
typestringquery
regular | ab_test | rss_issue | resend
sinceSendTimestringquery
beforeSendTimestringquery

Code samples

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

Responses

200 Default Response
Example
{
  "items": [
    {
      "sent": 0,
      "delivered": 0,
      "opens": {
        "total": 0,
        "unique": 0,
        "last": "2024-01-01T00:00:00Z"
      },
      "clicks": {
        "total": 0,
        "unique": 0,
        "last": "2024-01-01T00:00:00Z"
      },
      "bounces": {
        "hard": 0,
        "soft": 0
      },
      "unsubscribed": 0,
      "complaints": 0,
      "forwards": 0,
      "rates": {
        "deliveryRate": 0,
        "openRate": 0,
        "clickRate": 0,
        "clickToOpenRate": 0,
        "bounceRate": 0,
        "unsubscribeRate": 0,
        "complaintRate": 0
      },
      "id": "string",
      "campaignId": "string",
      "name": "string",
      "status": "string",
      "channel": "string",
      "type": "string",
      "sendTime": "2024-01-01T00:00:00Z",
      "opened": 0,
      "clicked": 0
    }
  ],
  "nextCursor": "string"
}
Schema
itemsobject[]required
Show child parameters
sentintegerrequired
deliveredintegerrequired
opensobjectrequired
Show child parameters
totalintegerrequired
uniqueintegerrequired
laststringrequired
clicksobjectrequired
Show child parameters
totalintegerrequired
uniqueintegerrequired
laststringrequired
bouncesobjectrequired
Show child parameters
hardintegerrequired
softintegerrequired
unsubscribedintegerrequired
complaintsintegerrequired
forwardsnumberrequired
ratesobjectrequired
Show child parameters
deliveryRatenumberrequired
openRatenumberrequired
clickRatenumberrequired
clickToOpenRatenumberrequired
bounceRatenumberrequired
unsubscribeRatenumberrequired
complaintRatenumberrequired
idstringrequired
campaignIdstringrequired
namestringrequired
statusstringrequired
channelstringrequired
typestringrequired
sendTimestringrequired
openedintegerrequired
clickedintegerrequired
nextCursorstringrequired
4XX Default Response

Same as 4XX · PUT /v1/campaigns/{id}/postcard

5XX Default Response

Same as 4XX · PUT /v1/campaigns/{id}/postcard

Updated