newsletter API reference — Part 5

Embed

<a href="https://hermeticor.com/docs/ref-newsletter"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/6ddb6b60-e4af-4ab8-9e30-d59475817fd4/social-card.svg?v=3e7ae33eec8b" alt="newsletter" width="600" height="315"></a>

POSThttps://hermeticor.com/v1/newsletter/posts/{id}/email

Create the campaign for this post (draft, send now or schedule) with optional A/B subject

Parameters

idstringpathrequired

Request body

application/json

subjectstring

subjectBstring

previewTextstring

listIdstring

segmentIdstring

modestring

now | schedule | draft = draft

atstring

{
  "subject": "string",
  "subjectB": "string",
  "previewText": "string",
  "listId": "string",
  "segmentId": "string",
  "mode": "draft",
  "at": "2024-01-01T00:00:00Z"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/newsletter/posts/{id}/email" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"subject":"string","subjectB":"string","previewText":"string","listId":"string","segmentId":"string","mode":"draft","at":"2024-01-01T00:00:00Z"}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "campaignId": "string",
  "paidCampaignId": "string",
  "status": "string"
}

Schema

campaignIdstringrequired

paidCampaignIdstringrequired

statusstringrequired

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/newsletter/posts/{id}/email

POSThttps://hermeticor.com/v1/newsletter/posts/{id}/test-send

Send the real email to a few addresses through the campaign pipeline

Parameters

idstringpathrequired

Request body

application/json

emailsstring[]required

{
  "emails": [
    "string"
  ]
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/newsletter/posts/{id}/test-send" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"emails":["string"]}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "sent": 0,
  "blocked": 0
}

Schema

sentintegerrequired

blockedintegerrequired

4XX Default Response

Same as 4XX · POST /v1/newsletter/posts/{id}/email

5XX Default Response

Same as 4XX · POST /v1/newsletter/posts/{id}/email

POSThttps://hermeticor.com/v1/newsletter/posts/{id}/preview

Preview as a free reader, a paid reader, the email or the web page (from unsaved text if given)

Parameters

idstringpathrequired

Request body

application/json

asstring

free | paid | email | web = web

markdownstring

{
  "as": "web",
  "markdown": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/newsletter/posts/{id}/preview" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"as":"web","markdown":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "html": "string",
  "words": 0,
  "readMinutes": 0,
  "hasPaywall": true
}

Schema

htmlstringrequired

wordsintegerrequired

readMinutesintegerrequired

hasPaywallbooleanrequired

4XX Default Response

Same as 4XX · POST /v1/newsletter/posts/{id}/email

5XX Default Response

Same as 4XX · POST /v1/newsletter/posts/{id}/email

GEThttps://hermeticor.com/v1/newsletter/posts/{id}/revisions

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/newsletter/posts/{id}/revisions" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "postId": "string",
      "title": "string",
      "subtitle": "string",
      "markdown": "string",
      "note": "string",
      "createdBy": "string",
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

idstringrequired

postIdstringrequired

titlestringrequired

subtitlestringrequired

markdownstringrequired

notestringrequired

createdBystringrequired

createdAtstringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · POST /v1/newsletter/posts/{id}/email

5XX Default Response

Same as 4XX · POST /v1/newsletter/posts/{id}/email

POSThttps://hermeticor.com/v1/newsletter/posts/{id}/revisions/{revisionId}/restore

Parameters

idstringpathrequired

revisionIdstringpathrequired

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/newsletter/posts/{id}/revisions/{revisionId}/restore" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "id": "string",
  "publicationId": "string",
  "title": "string",
  "subtitle": "string",
  "slug": "string",
  "coverUrl": "string",
  "coverAlt": "string",
  "markdown": "string",
  "excerpt": "string",
  "authorIds": [
    "string"
  ],
  "sectionIds": [
    "string"
  ],
  "tags": [
    "string"
  ],
  "audience": {
    "kind": "everyone",
    "tierIds": [
      "string"
    ]
  },
  "delivery": "web",
  "featured": true,
  "seoTitle": "string",
  "seoDescription": "string",
  "seoImageUrl": "string",
  "noindex": true,
  "status": "draft",
  "publishedAt": "2024-01-01T00:00:00Z",
  "scheduledAt": "2024-01-01T00:00:00Z",
  "campaignId": "string",
  "paidCampaignId": "string",
  "emailError": "string",
  "wordCount": 0,
  "readMinutes": 0,
  "url": "string",
  "createdAt": "2024-01-01T00:00:00Z",
  "updatedAt": "2024-01-01T00:00:00Z"
}

Schema

idstringrequired

publicationIdstringrequired

titlestringrequired

subtitlestringrequired

slugstringrequired

coverUrlstringrequired

coverAltstringrequired

markdownstringrequired

excerptstringrequired

authorIdsstring[]required

sectionIdsstring[]required

tagsstring[]required

audienceobjectrequired

Show child parameters

kindstringrequired

everyone | free | paid | tiers

tierIdsstring[]

deliverystringrequired

web | email | both

featuredbooleanrequired

seoTitlestringrequired

seoDescriptionstringrequired

seoImageUrlstringrequired

noindexbooleanrequired

statusstringrequired

draft | scheduled | published | archived

publishedAtstringrequired

scheduledAtstringrequired

campaignIdstringrequired

paidCampaignIdstringrequired

emailErrorstringrequired

wordCountintegerrequired

readMinutesintegerrequired

urlstringrequired

createdAtstringrequired

updatedAtstringrequired

4XX Default Response

Same as 4XX · POST /v1/newsletter/posts/{id}/email

5XX Default Response

Same as 4XX · POST /v1/newsletter/posts/{id}/email

GEThttps://hermeticor.com/v1/newsletter/posts/{id}/analytics

Email stats from delivery, web views, read depth, referrers, attributed subscribes and upgrades

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "postId": "string",
  "web": {
    "views": 0,
    "uniqueReaders": 0,
    "avgSeconds": 0,
    "avgDepth": 0,
    "depthBuckets": [
      {
        "pct": 0,
        "readers": 0
      }
    ],
    "sections": [
      {
        "id": "string",
        "heading": "string",
        "readers": 0
      }
    ],
    "referrers": [
      {
        "host": "string",
        "views": 0
      }
    ],
    "daily": [
      {
        "day": "string",
        "views": 0
      }
    ]
  },
  "email": {
    "sent": 0,
    "opened": 0,
    "clicked": 0,
    "unsubscribed": 0,
    "links": [
      {
        "url": "string",
        "total": 0,
        "unique": 0
      }
    ]
  },
  "attributed": {
    "subscribes": 0,
    "upgrades": 0
  }
}

Schema

postIdstringrequired

webobjectrequired

Show child parameters

viewsintegerrequired

uniqueReadersintegerrequired

avgSecondsnumberrequired

avgDepthnumberrequired

depthBucketsobject[]required

Show child parameters

pctintegerrequired

readersintegerrequired

sectionsobject[]required

Show child parameters

idstringrequired

headingstringrequired

readersintegerrequired

referrersobject[]required

Show child parameters

hoststringrequired

viewsintegerrequired

dailyobject[]required

Show child parameters

daystringrequired

viewsintegerrequired

emailobjectrequired

Show child parameters

sentintegerrequired

openedintegerrequired

clickedintegerrequired

unsubscribedintegerrequired

linksLinksItem[]required

Show child parameters

urlstringrequired

totalintegerrequired

uniqueintegerrequired

attributedobjectrequired

Show child parameters

subscribesintegerrequired

upgradesintegerrequired

4XX Default Response

Same as 4XX · POST /v1/newsletter/posts/{id}/email

5XX Default Response

Same as 4XX · POST /v1/newsletter/posts/{id}/email

Next part

Updated Nov 8, 2026

Was this page helpful?