newsletter API reference — Part 3

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/publications/{id}/redirects

Parameters

idstringpathrequired

Request body

application/json

fromPathstringrequired

toPathstringrequired

statusnumber

= 301

{
  "fromPath": "string",
  "toPath": "string",
  "status": 301
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/newsletter/publications/{id}/redirects" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"fromPath":"string","toPath":"string","status":301}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "id": "string",
  "publicationId": "string",
  "fromPath": "string",
  "toPath": "string",
  "status": 0
}

Schema

idstringrequired

publicationIdstringrequired

fromPathstringrequired

toPathstringrequired

statusintegerrequired

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/publications/{id}/redirects

DELETEhttps://hermeticor.com/v1/newsletter/redirects/{id}

Parameters

idstringpathrequired

Code samples

cURL

curl -X DELETE "https://hermeticor.com/v1/newsletter/redirects/{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 · POST /v1/newsletter/publications/{id}/redirects

5XX Default Response

Same as 4XX · POST /v1/newsletter/publications/{id}/redirects

GEThttps://hermeticor.com/v1/newsletter/publications/{id}/domains

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "publicationId": "string",
      "domain": "string",
      "status": "pending",
      "lastError": "string",
      "lastCheckedAt": "2024-01-01T00:00:00Z",
      "verifiedAt": "2024-01-01T00:00:00Z",
      "records": [
        {
          "type": "TXT",
          "name": "string",
          "value": "string"
        }
      ],
      "routing": "live",
      "url": "string"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem190[]required

Show child parameters

idstringrequired

publicationIdstringrequired

domainstringrequired

statusstringrequired

pending | verified | failed

lastErrorstringrequired

lastCheckedAtstringrequired

verifiedAtstringrequired

recordsRecordsItem3[]required

Show child parameters

typestringrequired

TXT | CNAME

namestringrequired

valuestringrequired

routingstringrequired

live | pending_routing

urlstringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · POST /v1/newsletter/publications/{id}/redirects

5XX Default Response

Same as 4XX · POST /v1/newsletter/publications/{id}/redirects

POSThttps://hermeticor.com/v1/newsletter/publications/{id}/domains

Parameters

idstringpathrequired

Request body

application/json

domainstringrequired

{
  "domain": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/newsletter/publications/{id}/domains" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"domain":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "id": "string",
  "publicationId": "string",
  "domain": "string",
  "status": "pending",
  "lastError": "string",
  "lastCheckedAt": "2024-01-01T00:00:00Z",
  "verifiedAt": "2024-01-01T00:00:00Z",
  "records": [
    {
      "type": "TXT",
      "name": "string",
      "value": "string"
    }
  ],
  "routing": "live",
  "url": "string"
}

Schema

idstringrequired

publicationIdstringrequired

domainstringrequired

statusstringrequired

pending | verified | failed

lastErrorstringrequired

lastCheckedAtstringrequired

verifiedAtstringrequired

recordsRecordsItem3[]required

Show child parameters

typestringrequired

TXT | CNAME

namestringrequired

valuestringrequired

routingstringrequired

live | pending_routing

urlstringrequired

4XX Default Response

Same as 4XX · POST /v1/newsletter/publications/{id}/redirects

5XX Default Response

Same as 4XX · POST /v1/newsletter/publications/{id}/redirects

POSThttps://hermeticor.com/v1/newsletter/domains/{id}/verify

Check the DNS records now

Parameters

idstringpathrequired

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/newsletter/domains/{id}/verify" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/newsletter/publications/{id}/domains

4XX Default Response

Same as 4XX · POST /v1/newsletter/publications/{id}/redirects

5XX Default Response

Same as 4XX · POST /v1/newsletter/publications/{id}/redirects

DELETEhttps://hermeticor.com/v1/newsletter/domains/{id}

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · DELETE /v1/newsletter/redirects/{id}

4XX Default Response

Same as 4XX · POST /v1/newsletter/publications/{id}/redirects

5XX Default Response

Same as 4XX · POST /v1/newsletter/publications/{id}/redirects

GEThttps://hermeticor.com/v1/newsletter/posts

Parameters

limitintegerquery

= 50

cursorstringquery

publicationIdstringquery

statusstringquery

draft | scheduled | published | archived

qstringquery

sectionIdstringquery

authorIdstringquery

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "publicationId": "string",
      "title": "string",
      "subtitle": "string",
      "slug": "string",
      "coverUrl": "string",
      "coverAlt": "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"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

idstringrequired

publicationIdstringrequired

titlestringrequired

subtitlestringrequired

slugstringrequired

coverUrlstringrequired

coverAltstringrequired

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

nextCursorstringrequired

4XX Default Response

Same as 4XX · POST /v1/newsletter/publications/{id}/redirects

5XX Default Response

Same as 4XX · POST /v1/newsletter/publications/{id}/redirects

Next part

Updated Nov 8, 2026

Was this page helpful?