newsletter

Embed
Preview of the card
<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>
GEThttps://hermeticor.com/v1/newsletter/publications

Parameters

limitintegerquery
Page size; omitted returns the whole list
cursorstringquery
Opaque: the nextCursor of the previous page

Code samples

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

Responses

200 Default Response
Example
{
  "items": [
    {
      "name": "string",
      "slug": "string",
      "tagline": "string",
      "logoUrl": "string",
      "coverUrl": "string",
      "accentColor": "string",
      "fonts": {
        "heading": "string",
        "body": "string"
      },
      "about": "string",
      "social": [
        {
          "network": "string",
          "href": "string"
        }
      ],
      "senderName": "string",
      "route": {
        "connectionId": "string",
        "poolId": "string",
        "routePolicyId": "string"
      },
      "listId": "string",
      "segmentId": "string",
      "paidSegmentId": "string",
      "language": "en",
      "timezone": "UTC",
      "footer": "string",
      "seoTitle": "string",
      "seoDescription": "string",
      "seoImageUrl": "string",
      "id": "string",
      "url": "string",
      "createdAt": "2024-01-01T00:00:00Z",
      "updatedAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}
Schema
itemsItemsItem186[]required
Show child parameters
namestringrequired
slugstringrequired
taglinestring
logoUrlstring
coverUrlstring
accentColorstring
fontsobject
Show child parameters
headingstring
bodystring
aboutstring
socialSocialItem[]
Show child parameters
networkstringrequired
hrefstringrequired
senderNamestring
routeobject
Show child parameters
connectionIdstring
poolIdstring
routePolicyIdstring
listIdstring
segmentIdstring
paidSegmentIdstring
languagestring
= en
timezonestring
= UTC
footerstring
seoTitlestring
seoDescriptionstring
seoImageUrlstring
idstringrequired
urlstringrequired
createdAtstringrequired
updatedAtstringrequired
nextCursorstringrequired
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 /v1/newsletter/publications

POSThttps://hermeticor.com/v1/newsletter/publications

Request body

application/json
namestringrequired
slugstringrequired
taglinestring
logoUrlstring
coverUrlstring
accentColorstring
fontsobject
Show child parameters
headingstring
bodystring
aboutstring
socialSocialItem2[]
Show child parameters
networkstringrequired
hrefstringrequired
senderNamestring
routeobject
Show child parameters
connectionIdstring
poolIdstring
routePolicyIdstring
listIdstring
segmentIdstring
paidSegmentIdstring
languagestring
= en
timezonestring
= UTC
footerstring
seoTitlestring
seoDescriptionstring
seoImageUrlstring
{
  "name": "string",
  "slug": "string",
  "tagline": "string",
  "logoUrl": "string",
  "coverUrl": "string",
  "accentColor": "string",
  "fonts": {
    "heading": "string",
    "body": "string"
  },
  "about": "string",
  "social": [
    {
      "network": "string",
      "href": "string"
    }
  ],
  "senderName": "string",
  "route": {
    "connectionId": "string",
    "poolId": "string",
    "routePolicyId": "string"
  },
  "listId": "string",
  "segmentId": "string",
  "paidSegmentId": "string",
  "language": "en",
  "timezone": "UTC",
  "footer": "string",
  "seoTitle": "string",
  "seoDescription": "string",
  "seoImageUrl": "string"
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/newsletter/publications" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","slug":"string","tagline":"string","logoUrl":"string","coverUrl":"string","accentColor":"string","fonts":{"heading":"string","body":"string"},"about":"string","social":[{"network":"string","href":"string"}],"senderName":"string","route":{"connectionId":"string","poolId":"string","routePolicyId":"string"},"listId":"string","segmentId":"string","paidSegmentId":"string","language":"en","timezone":"UTC","footer":"string","seoTitle":"string","seoDescription":"string","seoImageUrl":"string"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

201 Default Response
Example
{
  "name": "string",
  "slug": "string",
  "tagline": "string",
  "logoUrl": "string",
  "coverUrl": "string",
  "accentColor": "string",
  "fonts": {
    "heading": "string",
    "body": "string"
  },
  "about": "string",
  "social": [
    {
      "network": "string",
      "href": "string"
    }
  ],
  "senderName": "string",
  "route": {
    "connectionId": "string",
    "poolId": "string",
    "routePolicyId": "string"
  },
  "listId": "string",
  "segmentId": "string",
  "paidSegmentId": "string",
  "language": "en",
  "timezone": "UTC",
  "footer": "string",
  "seoTitle": "string",
  "seoDescription": "string",
  "seoImageUrl": "string",
  "id": "string",
  "url": "string",
  "createdAt": "2024-01-01T00:00:00Z",
  "updatedAt": "2024-01-01T00:00:00Z"
}
Schema
namestringrequired
slugstringrequired
taglinestring
logoUrlstring
coverUrlstring
accentColorstring
fontsobject
Show child parameters
headingstring
bodystring
aboutstring
socialSocialItem[]
Show child parameters
networkstringrequired
hrefstringrequired
senderNamestring
routeobject
Show child parameters
connectionIdstring
poolIdstring
routePolicyIdstring
listIdstring
segmentIdstring
paidSegmentIdstring
languagestring
= en
timezonestring
= UTC
footerstring
seoTitlestring
seoDescriptionstring
seoImageUrlstring
idstringrequired
urlstringrequired
createdAtstringrequired
updatedAtstringrequired
4XX Default Response

Same as 4XX · GET /v1/newsletter/publications

5XX Default Response

Same as 4XX · GET /v1/newsletter/publications

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

Parameters

idstringpathrequired

Code samples

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

Responses

200 Default Response

Same as 201 · POST /v1/newsletter/publications

4XX Default Response

Same as 4XX · GET /v1/newsletter/publications

5XX Default Response

Same as 4XX · GET /v1/newsletter/publications

PATCHhttps://hermeticor.com/v1/newsletter/publications/{id}

Parameters

idstringpathrequired

Request body

application/json
namestring
slugstring
taglinestring
logoUrlstring
coverUrlstring
accentColorstring
fontsobject
Show child parameters
headingstring
bodystring
aboutstring
socialSocialItem2[]
Show child parameters
networkstringrequired
hrefstringrequired
senderNamestring
routeobject
Show child parameters
connectionIdstring
poolIdstring
routePolicyIdstring
listIdstring
segmentIdstring
paidSegmentIdstring
languagestring
timezonestring
footerstring
seoTitlestring
seoDescriptionstring
seoImageUrlstring
{
  "name": "string",
  "slug": "string",
  "tagline": "string",
  "logoUrl": "string",
  "coverUrl": "string",
  "accentColor": "string",
  "fonts": {
    "heading": "string",
    "body": "string"
  },
  "about": "string",
  "social": [
    {
      "network": "string",
      "href": "string"
    }
  ],
  "senderName": "string",
  "route": {
    "connectionId": "string",
    "poolId": "string",
    "routePolicyId": "string"
  },
  "listId": "string",
  "segmentId": "string",
  "paidSegmentId": "string",
  "language": "string",
  "timezone": "string",
  "footer": "string",
  "seoTitle": "string",
  "seoDescription": "string",
  "seoImageUrl": "string"
}

Code samples

cURL
curl -X PATCH "https://hermeticor.com/v1/newsletter/publications/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","slug":"string","tagline":"string","logoUrl":"string","coverUrl":"string","accentColor":"string","fonts":{"heading":"string","body":"string"},"about":"string","social":[{"network":"string","href":"string"}],"senderName":"string","route":{"connectionId":"string","poolId":"string","routePolicyId":"string"},"listId":"string","segmentId":"string","paidSegmentId":"string","language":"string","timezone":"string","footer":"string","seoTitle":"string","seoDescription":"string","seoImageUrl":"string"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 201 · POST /v1/newsletter/publications

4XX Default Response

Same as 4XX · GET /v1/newsletter/publications

5XX Default Response

Same as 4XX · GET /v1/newsletter/publications

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

Top posts by web views with the subscribes and upgrades they brought in

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

Responses

200 Default Response
Example
{
  "items": [
    {
      "postId": "string",
      "title": "string",
      "views": 0,
      "uniqueReaders": 0,
      "subscribes": 0,
      "upgrades": 0
    }
  ],
  "nextCursor": "string"
}
Schema
itemsobject[]required
Show child parameters
postIdstringrequired
titlestringrequired
viewsintegerrequired
uniqueReadersintegerrequired
subscribesintegerrequired
upgradesintegerrequired
nextCursorstringrequired
4XX Default Response

Same as 4XX · GET /v1/newsletter/publications

5XX Default Response

Same as 4XX · GET /v1/newsletter/publications

Updated