newsletter API reference — Part 9

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/members/{profileId}/reader-link

Signed link (30 days) to the reader-facing account page

Parameters

profileIdstringpathrequired

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/newsletter/members/{profileId}/reader-link" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "url": "string",
  "expiresAt": "2024-01-01T00:00:00Z"
}

Schema

urlstringrequired

expiresAtstringrequired

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/members/{profileId}/reader-link

GEThttps://hermeticor.com/v1/newsletter/members/{profileId}

Parameters

profileIdstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "id": "string",
  "profileId": "string",
  "email": "string",
  "tierId": "string",
  "tierName": "string",
  "status": "trialing",
  "interval": "month",
  "source": "string",
  "mrrMinor": 0,
  "currency": "string",
  "periodEnd": "2024-01-01T00:00:00Z",
  "trialEnd": "2024-01-01T00:00:00Z",
  "cancelAtPeriodEnd": true,
  "stripeCustomerId": "string",
  "stripeSubscriptionId": "string"
}

Schema

idstringrequired

profileIdstringrequired

emailstringrequired

tierIdstringrequired

tierNamestringrequired

statusstringrequired

intervalstringrequired

month | year

sourcestringrequired

mrrMinorintegerrequired

currencystringrequired

periodEndstringrequired

trialEndstringrequired

cancelAtPeriodEndbooleanrequired

stripeCustomerIdstringrequired

stripeSubscriptionIdstringrequired

4XX Default Response

Same as 4XX · POST /v1/newsletter/members/{profileId}/reader-link

5XX Default Response

Same as 4XX · POST /v1/newsletter/members/{profileId}/reader-link

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

Stripe Checkout link for a tier (send it to the subscriber)

Request body

application/json

emailstring

profileIdstring

tierIdstringrequired

intervalstring

month | year = month

couponCodestring

seatsinteger

successUrlstring

cancelUrlstring

optInboolean

= false

fromPostIdstring

{
  "email": "string",
  "profileId": "string",
  "tierId": "string",
  "interval": "month",
  "couponCode": "string",
  "seats": 0,
  "successUrl": "string",
  "cancelUrl": "string",
  "optIn": false,
  "fromPostId": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/newsletter/checkout" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"email":"string","profileId":"string","tierId":"string","interval":"month","couponCode":"string","seats":0,"successUrl":"string","cancelUrl":"string","optIn":false,"fromPostId":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "url": "string"
}

Schema

urlstringrequired

4XX Default Response

Same as 4XX · POST /v1/newsletter/members/{profileId}/reader-link

5XX Default Response

Same as 4XX · POST /v1/newsletter/members/{profileId}/reader-link

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

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/groups" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "name": "string",
      "tierId": "string",
      "ownerProfileId": "string",
      "seats": 0,
      "used": 0,
      "status": "string"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

idstringrequired

namestringrequired

tierIdstringrequired

ownerProfileIdstringrequired

seatsintegerrequired

usedintegerrequired

statusstringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · POST /v1/newsletter/members/{profileId}/reader-link

5XX Default Response

Same as 4XX · POST /v1/newsletter/members/{profileId}/reader-link

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

Change the paid seat count of a team plan (prorated by Stripe)

Parameters

idstringpathrequired

Request body

application/json

seatsintegerrequired

{
  "seats": 0
}

Code samples

cURL

curl -X PATCH "https://hermeticor.com/v1/newsletter/groups/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"seats":0}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "ok": true
}

Schema

okbooleanrequired

true

4XX Default Response

Same as 4XX · POST /v1/newsletter/members/{profileId}/reader-link

5XX Default Response

Same as 4XX · POST /v1/newsletter/members/{profileId}/reader-link

GEThttps://hermeticor.com/v1/newsletter/groups/{id}/seats

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "groupId": "string",
      "email": "string",
      "profileId": "string",
      "status": "active"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem195[]required

Show child parameters

idstringrequired

groupIdstringrequired

emailstringrequired

profileIdstringrequired

statusstringrequired

active | removed

nextCursorstringrequired

4XX Default Response

Same as 4XX · POST /v1/newsletter/members/{profileId}/reader-link

5XX Default Response

Same as 4XX · POST /v1/newsletter/members/{profileId}/reader-link

POSThttps://hermeticor.com/v1/newsletter/groups/{id}/seats

Parameters

idstringpathrequired

Request body

application/json

emailstringrequired

{
  "email": "string"
}

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "id": "string",
  "groupId": "string",
  "email": "string",
  "profileId": "string",
  "status": "active"
}

Schema

idstringrequired

groupIdstringrequired

emailstringrequired

profileIdstringrequired

statusstringrequired

active | removed

4XX Default Response

Same as 4XX · POST /v1/newsletter/members/{profileId}/reader-link

5XX Default Response

Same as 4XX · POST /v1/newsletter/members/{profileId}/reader-link

DELETEhttps://hermeticor.com/v1/newsletter/groups/{id}/seats/{seatId}

Parameters

idstringpathrequired

seatIdstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · PATCH /v1/newsletter/groups/{id}

4XX Default Response

Same as 4XX · POST /v1/newsletter/members/{profileId}/reader-link

5XX Default Response

Same as 4XX · POST /v1/newsletter/members/{profileId}/reader-link

Next part

Updated Nov 8, 2026

Was this page helpful?