newsletter-site

Embed
Preview of the card
<a href="https://hermeticor.com/docs/ref-newsletter-site"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/785a90d6-d113-4561-a162-0888b290dff1/social-card.svg?v=3e7ae33eec8b" alt="newsletter-site" width="600" height="315"></a>
GEThttps://hermeticor.com/p/n/{ref}/upgrade

Upgrade to a paid subscription

Parameters

fromstringquery
errorstringquery
refstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/p/n/{ref}/upgrade"
TypeScript
Python
Go
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/n/{ref}/upgrade

POSThttps://hermeticor.com/p/n/{ref}/upgrade

Start Checkout from the upgrade page (opt-in box unticked unless the reader ticks it)

Parameters

refstringpathrequired

Request body

application/json
{}

Code samples

cURL
curl -X POST "https://hermeticor.com/p/n/{ref}/upgrade" \
  -H "Content-Type: application/json" \
  -d '{}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
"string"
4XX Default Response

Same as 4XX · GET /p/n/{ref}/upgrade

5XX Default Response

Same as 4XX · GET /p/n/{ref}/upgrade

GEThttps://hermeticor.com/p/n/{ref}/p/{slug}/highlights

The signed-in reader's own highlights on a post

Parameters

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

Code samples

cURL
curl -X GET "https://hermeticor.com/p/n/{ref}/p/{slug}/highlights"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "items": [
    {
      "id": "string",
      "quote": "string",
      "note": "string",
      "notePublic": true,
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}
Schema
itemsItemsItem206[]required
Show child parameters
idstringrequired
quotestringrequired
notestringrequired
notePublicbooleanrequired
createdAtstringrequired
nextCursorstringrequired
4XX Default Response

Same as 4XX · GET /p/n/{ref}/upgrade

5XX Default Response

Same as 4XX · GET /p/n/{ref}/upgrade

POSThttps://hermeticor.com/p/n/{ref}/p/{slug}/highlights

Save a highlight with an optional note (private unless the reader shares the note)

Parameters

refstringpathrequired
slugstringpathrequired

Request body

application/json
quotestringrequired
notestring
notePublicboolean
= false
{
  "quote": "string",
  "note": "string",
  "notePublic": false
}

Code samples

cURL
curl -X POST "https://hermeticor.com/p/n/{ref}/p/{slug}/highlights" \
  -H "Content-Type: application/json" \
  -d '{"quote":"string","note":"string","notePublic":false}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "id": "string",
  "quote": "string",
  "note": "string",
  "notePublic": true,
  "createdAt": "2024-01-01T00:00:00Z"
}
Schema
idstringrequired
quotestringrequired
notestringrequired
notePublicbooleanrequired
createdAtstringrequired
4XX Default Response

Same as 4XX · GET /p/n/{ref}/upgrade

5XX Default Response

Same as 4XX · GET /p/n/{ref}/upgrade

DELETEhttps://hermeticor.com/p/n/{ref}/p/{slug}/highlights/{id}

Remove one of the reader's own highlights

Parameters

refstringpathrequired
slugstringpathrequired
idstringpathrequired

Code samples

cURL
curl -X DELETE "https://hermeticor.com/p/n/{ref}/p/{slug}/highlights/{id}"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "ok": true
}
Schema
okbooleanrequired
true
4XX Default Response

Same as 4XX · GET /p/n/{ref}/upgrade

5XX Default Response

Same as 4XX · GET /p/n/{ref}/upgrade

Updated