engagement

Embed
Preview of the card
<a href="https://hermeticor.com/docs/ref-engagement"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/3918a56f-6a77-482b-ab0a-92946bdb316a/social-card.svg?v=3e7ae33eec8b" alt="engagement" width="600" height="315"></a>
PATCHhttps://hermeticor.com/v1/newsletter/engagement/replies/{id}

Mark a reply read or archived

Parameters

idstringpathrequired

Request body

application/json
readboolean
archivedboolean
{
  "read": true,
  "archived": true
}

Code samples

cURL
curl -X PATCH "https://hermeticor.com/v1/newsletter/engagement/replies/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"read":true,"archived":true}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "ok": true
}
Schema
okbooleanrequired
true
4XX Default Response
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
detailsobject
5XX Default Response

Same as 4XX · PATCH /v1/newsletter/engagement/replies/{id}

GEThttps://hermeticor.com/e/widget.js

Embed script: turns <div data-hermetica-comments="workspace/post"> into the comments widget

Code samples

cURL
curl -X GET "https://hermeticor.com/e/widget.js"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
"string"
4XX Default Response

Same as 4XX · PATCH /v1/newsletter/engagement/replies/{id}

5XX Default Response

Same as 4XX · PATCH /v1/newsletter/engagement/replies/{id}

GEThttps://hermeticor.com/e/c/{ws}/{postId}

Comments and reactions for a post (server-rendered, embeddable)

Parameters

tstringquery
wsstringpathrequired
postIdstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/e/c/{ws}/{postId}"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
"string"
4XX Default Response

Same as 4XX · PATCH /v1/newsletter/engagement/replies/{id}

5XX Default Response

Same as 4XX · PATCH /v1/newsletter/engagement/replies/{id}

POSThttps://hermeticor.com/e/c/{ws}/{postId}

Comment, reply, edit, delete, like or react (form post, reader token required)

Parameters

wsstringpathrequired
postIdstringpathrequired

Request body

application/json
{}

Code samples

cURL
curl -X POST "https://hermeticor.com/e/c/{ws}/{postId}" \
  -H "Content-Type: application/json" \
  -d '{}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
"string"
4XX Default Response

Same as 4XX · PATCH /v1/newsletter/engagement/replies/{id}

5XX Default Response

Same as 4XX · PATCH /v1/newsletter/engagement/replies/{id}

POSThttps://hermeticor.com/e/link/{ws}/{kind}/{id}

Email a sign-in link (same reply whether or not the address is known)

Parameters

wsstringpathrequired
idstringpathrequired
kindstringpathrequired
c | poll | survey

Request body

application/json
{}

Code samples

cURL
curl -X POST "https://hermeticor.com/e/link/{ws}/{kind}/{id}" \
  -H "Content-Type: application/json" \
  -d '{}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
"string"
4XX Default Response

Same as 4XX · PATCH /v1/newsletter/engagement/replies/{id}

5XX Default Response

Same as 4XX · PATCH /v1/newsletter/engagement/replies/{id}

GEThttps://hermeticor.com/e/poll/{ws}/{id}

Hosted poll page

Parameters

tstringquery
wsstringpathrequired
idstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/e/poll/{ws}/{id}"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
"string"
4XX Default Response

Same as 4XX · PATCH /v1/newsletter/engagement/replies/{id}

5XX Default Response

Same as 4XX · PATCH /v1/newsletter/engagement/replies/{id}

GEThttps://hermeticor.com/e/survey/{ws}/{id}

Hosted survey page

Parameters

tstringquery
wsstringpathrequired
idstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/e/survey/{ws}/{id}"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
"string"
4XX Default Response

Same as 4XX · PATCH /v1/newsletter/engagement/replies/{id}

5XX Default Response

Same as 4XX · PATCH /v1/newsletter/engagement/replies/{id}

POSThttps://hermeticor.com/e/survey/{ws}/{id}

Submit (or change) survey answers

Parameters

wsstringpathrequired
idstringpathrequired

Request body

application/json
{}

Code samples

cURL
curl -X POST "https://hermeticor.com/e/survey/{ws}/{id}" \
  -H "Content-Type: application/json" \
  -d '{}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
"string"
4XX Default Response

Same as 4XX · PATCH /v1/newsletter/engagement/replies/{id}

5XX Default Response

Same as 4XX · PATCH /v1/newsletter/engagement/replies/{id}

GEThttps://hermeticor.com/e/s/{ws}/{token}

Anonymous survey link: a blank form (never earlier answers or results)

Parameters

wsstringpathrequired
tokenstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/e/s/{ws}/{token}"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
"string"
4XX Default Response

Same as 4XX · PATCH /v1/newsletter/engagement/replies/{id}

5XX Default Response

Same as 4XX · PATCH /v1/newsletter/engagement/replies/{id}

POSThttps://hermeticor.com/e/s/{ws}/{token}

Submit answers through the anonymous survey link

Parameters

wsstringpathrequired
tokenstringpathrequired

Request body

application/json
{}

Code samples

cURL
curl -X POST "https://hermeticor.com/e/s/{ws}/{token}" \
  -H "Content-Type: application/json" \
  -d '{}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
"string"
4XX Default Response

Same as 4XX · PATCH /v1/newsletter/engagement/replies/{id}

5XX Default Response

Same as 4XX · PATCH /v1/newsletter/engagement/replies/{id}

GEThttps://hermeticor.com/e/results/{ws}/{id}

Poll results page

Parameters

wsstringpathrequired
idstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/e/results/{ws}/{id}"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
"string"
4XX Default Response

Same as 4XX · PATCH /v1/newsletter/engagement/replies/{id}

5XX Default Response

Same as 4XX · PATCH /v1/newsletter/engagement/replies/{id}

GEThttps://hermeticor.com/e/v/{poll}/{opt}/{*}

Poll option link from an email: confirmation page (changes nothing until posted)

Parameters

pollstringpathrequired
optstringpathrequired
*stringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/e/v/{poll}/{opt}/{*}"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
"string"
4XX Default Response

Same as 4XX · PATCH /v1/newsletter/engagement/replies/{id}

5XX Default Response

Same as 4XX · PATCH /v1/newsletter/engagement/replies/{id}

POSThttps://hermeticor.com/e/v/{poll}/{opt}/{*}

Record a poll vote from an email link (one per reader, changeable)

Parameters

pollstringpathrequired
optstringpathrequired
*stringpathrequired

Code samples

cURL
curl -X POST "https://hermeticor.com/e/v/{poll}/{opt}/{*}"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
"string"
4XX Default Response

Same as 4XX · PATCH /v1/newsletter/engagement/replies/{id}

5XX Default Response

Same as 4XX · PATCH /v1/newsletter/engagement/replies/{id}

Updated