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>
POSThttps://hermeticor.com/v1/campaigns/{id}/drafts/decide

Approve (send) or reject the selected drafts

Parameters

idstringpathrequired

Request body

application/json
idsstring[]required
actionstringrequired
approve | reject
{
  "ids": [
    "string"
  ],
  "action": "approve"
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/campaigns/{id}/drafts/decide" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"ids":["string"],"action":"approve"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "decided": 0,
  "failed": 0
}
Schema
decidedintegerrequired
failedintegerrequired
4XX Default Response
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
detailsobject
5XX Default Response

Same as 4XX · POST /v1/campaigns/{id}/drafts/decide

GEThttps://hermeticor.com/v1/campaign-folders/{id}/budgets

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/campaign-folders/{id}/budgets" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "items": [
    {
      "id": "string",
      "name": "string",
      "currency": "string",
      "amountMinor": 0,
      "spentMinor": 0,
      "remainingMinor": 0,
      "overBudget": true,
      "folderId": "string"
    }
  ],
  "nextCursor": "string"
}
Schema
itemsPutV1BudgetsByIdFolderResponse[]required
Show child parameters
idstringrequired
namestringrequired
currencystringrequired
amountMinorintegerrequired
spentMinorintegerrequired
remainingMinorintegerrequired
overBudgetbooleanrequired
folderIdstringrequired
nextCursorstringrequired
4XX Default Response

Same as 4XX · POST /v1/campaigns/{id}/drafts/decide

5XX Default Response

Same as 4XX · POST /v1/campaigns/{id}/drafts/decide

GEThttps://hermeticor.com/v1/emails

Campaigns as one email list: state, type, channel, created/updated/scheduled ranges, archived and sort

Parameters

statestringquery
draft | scheduled | sending | paused | completed | cancelled | failed
channelstringquery
email | sms | whatsapp | push | postcard
typestringquery
marketing | prospecting | transactional | operational
qstringquery
createdFromstringquery
createdTostringquery
updatedFromstringquery
updatedTostringquery
scheduledFromstringquery
scheduledTostringquery
archivedstringquery
true | false
sortstringquery
created | updated | name | scheduled = created
orderstringquery
asc | desc = desc
limitintegerquery
= 50
cursorstringquery

Code samples

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

Responses

200 Default Response
Example
{
  "items": [
    {
      "id": "string",
      "name": "string",
      "state": "string",
      "channel": "string",
      "type": "string",
      "archived": true,
      "scheduledAt": "string",
      "createdAt": "string",
      "updatedAt": "string"
    }
  ],
  "nextCursor": "string"
}
Schema
itemsobject[]required
Show child parameters
idstringrequired
namestringrequired
statestringrequired
channelstringrequired
typestringrequired
archivedbooleanrequired
scheduledAtstringrequired
createdAtstringrequired
updatedAtstringrequired
nextCursorstringrequired
4XX Default Response

Same as 4XX · POST /v1/campaigns/{id}/drafts/decide

5XX Default Response

Same as 4XX · POST /v1/campaigns/{id}/drafts/decide

GEThttps://hermeticor.com/v1/emails/{id}/draft

The editable content of an email that has not been sent

Parameters

idstringpathrequired

Code samples

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

Responses

200 Default Response
Example
{
  "messageId": "string",
  "source": "template",
  "templateId": "string",
  "templateVersionId": "string",
  "html": "string",
  "plainText": "string",
  "blocks": {}
}
Schema
messageIdstringrequired
sourcestringrequired
template | html | blocks | none
templateIdstringrequired
templateVersionIdstringrequired
htmlstringrequired
plainTextstringrequired
blocksrequired
4XX Default Response

Same as 4XX · POST /v1/campaigns/{id}/drafts/decide

5XX Default Response

Same as 4XX · POST /v1/campaigns/{id}/drafts/decide

PATCHhttps://hermeticor.com/v1/emails/{id}/draft

Edit the draft; refused once the email is sending or sent

Parameters

idstringpathrequired

Request body

application/json
templateobject
Show child parameters
templateIdstringrequired
versionIdstring
htmlstring
urlstring
blocksobject
plainTextstring
{
  "template": {
    "templateId": "string",
    "versionId": "string"
  },
  "html": "string",
  "url": "string",
  "blocks": {},
  "plainText": "string"
}

Code samples

cURL
curl -X PATCH "https://hermeticor.com/v1/emails/{id}/draft" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"template":{"templateId":"string","versionId":"string"},"html":"string","url":"string","blocks":{},"plainText":"string"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 200 · GET /v1/emails/{id}/draft

4XX Default Response

Same as 4XX · POST /v1/campaigns/{id}/drafts/decide

5XX Default Response

Same as 4XX · POST /v1/campaigns/{id}/drafts/decide

GEThttps://hermeticor.com/v1/emails/statistics/list

Totals for up to 50 emails (comma separated ids) in a date window, plus their sum

Parameters

idsstringqueryrequired
fromstringquery
tostringquery

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/emails/statistics/list?ids=<ids>" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "window": {
    "from": "string",
    "to": "string"
  },
  "items": [
    {
      "id": "string",
      "totals": {}
    }
  ],
  "aggregate": {}
}
Schema
windowobjectrequired
Show child parameters
fromstringrequired
tostringrequired
itemsobject[]required
Show child parameters
idstringrequired
totalsobjectrequired
aggregateobjectrequired
4XX Default Response

Same as 4XX · POST /v1/campaigns/{id}/drafts/decide

5XX Default Response

Same as 4XX · POST /v1/campaigns/{id}/drafts/decide

GEThttps://hermeticor.com/v1/emails/statistics/histogram

Sent, delivered, bounced, opened and clicked for one email per day, week or month between start and end

Parameters

idstringqueryrequired
startstringquery
endstringquery
intervalstringquery
day | week | month = day
daysintegerquery
= 30

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/emails/statistics/histogram?id=<id>" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "id": "string",
  "start": "string",
  "end": "string",
  "interval": "day",
  "items": [
    {
      "day": "string",
      "sent": 0,
      "delivered": 0,
      "bounced": 0,
      "opens": 0,
      "clicks": 0
    }
  ]
}
Schema
idstringrequired
startstringrequired
endstringrequired
intervalstringrequired
day | week | month
itemsobject[]required
Show child parameters
daystringrequired
sentnumberrequired
deliverednumberrequired
bouncednumberrequired
opensnumberrequired
clicksnumberrequired
4XX Default Response

Same as 4XX · POST /v1/campaigns/{id}/drafts/decide

5XX Default Response

Same as 4XX · POST /v1/campaigns/{id}/drafts/decide

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

Parameters

idstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/campaigns/{id}/postcard" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
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

Same as 4XX · POST /v1/campaigns/{id}/drafts/decide

5XX Default Response

Same as 4XX · POST /v1/campaigns/{id}/drafts/decide

Updated