campaigns

Embed

<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>

GEThttps://hermeticor.com/p/a/{ref}/latest

Permalink that redirects to the newest campaign in the archive

Parameters

refstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/p/a/{ref}/latest"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

"string"

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 /p/a/{ref}/latest

GEThttps://hermeticor.com/p/a/{ref}/{slug}

One archived campaign by slug

Parameters

refstringpathrequired

slugstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/p/a/{ref}/{slug}"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

"string"

4XX Default Response

Same as 4XX · GET /p/a/{ref}/latest

5XX Default Response

Same as 4XX · GET /p/a/{ref}/latest

GEThttps://hermeticor.com/v1/programs

Marketing programs: named containers for the campaigns, journeys, forms and pages of one initiative

Parameters

limitintegerquery

= 50

cursorstringquery

statusstringquery

planned | active | completed | archived

qstringquery

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/programs" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "status": "planned",
      "startsOn": "string",
      "endsOn": "string",
      "budgetCents": 0,
      "ownerUserId": "string",
      "assetCount": 0,
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem163[]required

Show child parameters

idstringrequired

namestringrequired

descriptionstringrequired

statusstringrequired

planned | active | completed | archived

startsOnstringrequired

endsOnstringrequired

budgetCentsintegerrequired

ownerUserIdstringrequired

assetCountintegerrequired

createdAtstringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · GET /p/a/{ref}/latest

5XX Default Response

Same as 4XX · GET /p/a/{ref}/latest

POSThttps://hermeticor.com/v1/programs

Request body

application/json

namestringrequired

descriptionstring

statusstring

planned | active | completed | archived = planned

startsOnstring

endsOnstring

budgetCentsinteger

ownerUserIdstring

{
  "name": "string",
  "description": "string",
  "status": "planned",
  "startsOn": "string",
  "endsOn": "string",
  "budgetCents": 0,
  "ownerUserId": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/programs" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","description":"string","status":"planned","startsOn":"string","endsOn":"string","budgetCents":0,"ownerUserId":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "id": "string",
  "name": "string",
  "description": "string",
  "status": "planned",
  "startsOn": "string",
  "endsOn": "string",
  "budgetCents": 0,
  "ownerUserId": "string",
  "assetCount": 0,
  "createdAt": "2024-01-01T00:00:00Z"
}

Schema

idstringrequired

namestringrequired

descriptionstringrequired

statusstringrequired

planned | active | completed | archived

startsOnstringrequired

endsOnstringrequired

budgetCentsintegerrequired

ownerUserIdstringrequired

assetCountintegerrequired

createdAtstringrequired

4XX Default Response

Same as 4XX · GET /p/a/{ref}/latest

5XX Default Response

Same as 4XX · GET /p/a/{ref}/latest

GEThttps://hermeticor.com/v1/programs/{id}

A program with its assets and the roll-up of sent, opened and clicked across its campaigns and journeys

Parameters

idstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/programs/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "program": {
    "id": "string",
    "name": "string",
    "description": "string",
    "status": "planned",
    "startsOn": "string",
    "endsOn": "string",
    "budgetCents": 0,
    "ownerUserId": "string",
    "assetCount": 0,
    "createdAt": "2024-01-01T00:00:00Z"
  },
  "assets": [
    {
      "kind": "campaign",
      "assetId": "string"
    }
  ],
  "counts": {},
  "totals": {
    "sent": 0,
    "opened": 0,
    "clicked": 0,
    "orders": 0,
    "revenue": [
      {
        "currency": "string",
        "minor": 0
      }
    ]
  },
  "perSource": [
    {
      "kind": "campaign",
      "assetId": "string",
      "sent": 0,
      "opened": 0,
      "clicked": 0,
      "orders": 0,
      "revenue": [
        {
          "currency": "string",
          "minor": 0
        }
      ]
    }
  ]
}

Schema

programobjectrequired

Show child parameters

idstringrequired

namestringrequired

descriptionstringrequired

statusstringrequired

planned | active | completed | archived

startsOnstringrequired

endsOnstringrequired

budgetCentsintegerrequired

ownerUserIdstringrequired

assetCountintegerrequired

createdAtstringrequired

assetsobject[]required

Show child parameters

kindstringrequired

assetIdstringrequired

countsobjectrequired

totalsobjectrequired

Show child parameters

sentintegerrequired

openedintegerrequired

clickedintegerrequired

ordersintegerrequired

revenueRevenueItem2[]required

Show child parameters

currencystringrequired

minorintegerrequired

perSourceobject[]required

Show child parameters

kindstringrequired

campaign | journey

assetIdstringrequired

sentintegerrequired

openedintegerrequired

clickedintegerrequired

ordersintegerrequired

revenueRevenueItem2[]required

Show child parameters

currencystringrequired

minorintegerrequired

4XX Default Response

Same as 4XX · GET /p/a/{ref}/latest

5XX Default Response

Same as 4XX · GET /p/a/{ref}/latest

DELETEhttps://hermeticor.com/v1/programs/{id}

Delete a program; the assets in it are not touched

Parameters

idstringpathrequired

Code samples

cURL

curl -X DELETE "https://hermeticor.com/v1/programs/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "ok": true
}

Schema

okbooleanrequired

true

4XX Default Response

Same as 4XX · GET /p/a/{ref}/latest

5XX Default Response

Same as 4XX · GET /p/a/{ref}/latest

PATCHhttps://hermeticor.com/v1/programs/{id}

Parameters

idstringpathrequired

Request body

application/json

namestring

descriptionstring

statusstring

planned | active | completed | archived

startsOnstring

endsOnstring

budgetCentsinteger

ownerUserIdstring

{
  "name": "string",
  "description": "string",
  "status": "planned",
  "startsOn": "string",
  "endsOn": "string",
  "budgetCents": 0,
  "ownerUserId": "string"
}

Code samples

cURL

curl -X PATCH "https://hermeticor.com/v1/programs/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","description":"string","status":"planned","startsOn":"string","endsOn":"string","budgetCents":0,"ownerUserId":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/programs

4XX Default Response

Same as 4XX · GET /p/a/{ref}/latest

5XX Default Response

Same as 4XX · GET /p/a/{ref}/latest

GEThttps://hermeticor.com/v1/campaigns/{id}/content-check

Writing and layout checks on the first message of an email campaign: subject length, reading ease, call to action, length

Parameters

idstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/campaigns/{id}/content-check" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "score": 0,
  "checks": [
    {
      "id": "string",
      "level": "good",
      "title": "string",
      "detail": "string"
    }
  ],
  "stats": {
    "words": 0,
    "sentences": 0,
    "avgSentenceWords": 0,
    "links": 0,
    "images": 0
  }
}

Schema

scoreintegerrequired

checksChecksItem[]required

Show child parameters

idstringrequired

levelstringrequired

good | tip | fix

titlestringrequired

detailstringrequired

statsobjectrequired

Show child parameters

wordsintegerrequired

sentencesintegerrequired

avgSentenceWordsintegerrequired

linksintegerrequired

imagesintegerrequired

4XX Default Response

Same as 4XX · GET /p/a/{ref}/latest

5XX Default Response

Same as 4XX · GET /p/a/{ref}/latest

Next part

Updated Nov 8, 2026

Was this page helpful?