engagement

Embed

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

Rename, describe, open or close, link a list, set the thank-you, turn the anonymous link on or off, edit questions

Parameters

idstringpathrequired

Request body

application/json

titlestring

descriptionstring

statusstring

open | closed

listIdstring

thankYouTextstring

anonymousboolean

questionsQuestionsItem2[]

Show child parameters

idstring

promptstringrequired

kindstringrequired

single | multi | text | rating | email

optionsOptionsItem2[]

requiredboolean

= true

attributeKeystring

{
  "title": "string",
  "description": "string",
  "status": "open",
  "listId": "string",
  "thankYouText": "string",
  "anonymous": true,
  "questions": [
    {
      "id": "string",
      "prompt": "string",
      "kind": "single",
      "options": [
        "string"
      ],
      "required": true,
      "attributeKey": "string"
    }
  ]
}

Code samples

cURL

curl -X PATCH "https://hermeticor.com/v1/newsletter/engagement/surveys/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"title":"string","description":"string","status":"open","listId":"string","thankYouText":"string","anonymous":true,"questions":[{"id":"string","prompt":"string","kind":"single","options":["string"],"required":true,"attributeKey":"string"}]}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "id": "string",
  "kind": "poll",
  "publicationId": "string",
  "postId": "string",
  "title": "string",
  "description": "string",
  "status": "open",
  "questions": [
    {
      "id": "string",
      "prompt": "string",
      "kind": "single",
      "options": [
        {
          "id": "string",
          "label": "string"
        }
      ],
      "required": true,
      "attributeKey": "string",
      "position": 0
    }
  ],
  "responses": 0,
  "createdAt": "2024-01-01T00:00:00Z",
  "block": {},
  "listId": "string",
  "thankYouText": "string",
  "views": 0,
  "anonymousPath": "string"
}

Schema

idstringrequired

kindstringrequired

poll | survey

publicationIdstringrequired

postIdstringrequired

titlestringrequired

descriptionstringrequired

statusstringrequired

open | closed

questionsQuestionsItem[]required

Show child parameters

idstringrequired

promptstringrequired

kindstringrequired

single | multi | text | rating | email

optionsOptionsItem[]required

Show child parameters

idstringrequired

labelstringrequired

requiredbooleanrequired

attributeKeystringrequired

positionintegerrequired

responsesintegerrequired

createdAtstringrequired

blockobjectrequired

listIdstringrequired

thankYouTextstringrequired

viewsintegerrequired

anonymousPathstringrequired

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

GEThttps://hermeticor.com/v1/newsletter/engagement/surveys/{id}/results

Results per question

Parameters

idstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/newsletter/engagement/surveys/{id}/results" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "surveyId": "string",
  "responses": 0,
  "questions": [
    {
      "questionId": "string",
      "prompt": "string",
      "kind": "single",
      "total": 0,
      "options": [
        {
          "id": "string",
          "label": "string",
          "votes": 0
        }
      ],
      "average": 0,
      "texts": [
        "string"
      ]
    }
  ]
}

Schema

surveyIdstringrequired

responsesintegerrequired

questionsobject[]required

Show child parameters

questionIdstringrequired

promptstringrequired

kindstringrequired

single | multi | text | rating | email

totalintegerrequired

optionsOptionsItem3[]required

Show child parameters

idstringrequired

labelstringrequired

votesintegerrequired

averagenumberrequired

textsstring[]required

4XX Default Response

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

5XX Default Response

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

GEThttps://hermeticor.com/v1/newsletter/engagement/surveys/{id}/responses

Individual responses (respondent, time, answers), newest first

Parameters

limitintegerquery

= 50

cursorstringquery

idstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/newsletter/engagement/surveys/{id}/responses" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "respondent": "string",
      "profileId": "string",
      "contactProfileId": "string",
      "anonymous": true,
      "submittedAt": "2024-01-01T00:00:00Z",
      "answers": [
        {
          "questionId": "string",
          "optionIds": [
            "string"
          ],
          "value": "string"
        }
      ]
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem205[]required

Show child parameters

respondentstringrequired

profileIdstringrequired

contactProfileIdstringrequired

anonymousbooleanrequired

submittedAtstringrequired

answersAnswersItem[]required

Show child parameters

questionIdstringrequired

optionIdsstring[]required

valuestringrequired

nextCursorstringrequired

4XX Default Response

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

5XX Default Response

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

GEThttps://hermeticor.com/v1/newsletter/engagement/surveys/{id}/responses/{respondent}

One respondent's answers

Parameters

idstringpathrequired

respondentstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/newsletter/engagement/surveys/{id}/responses/{respondent}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "respondent": "string",
  "profileId": "string",
  "contactProfileId": "string",
  "anonymous": true,
  "submittedAt": "2024-01-01T00:00:00Z",
  "answers": [
    {
      "questionId": "string",
      "optionIds": [
        "string"
      ],
      "value": "string"
    }
  ]
}

Schema

respondentstringrequired

profileIdstringrequired

contactProfileIdstringrequired

anonymousbooleanrequired

submittedAtstringrequired

answersAnswersItem[]required

Show child parameters

questionIdstringrequired

optionIdsstring[]required

valuestringrequired

4XX Default Response

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

5XX Default Response

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

POSThttps://hermeticor.com/v1/newsletter/engagement/surveys/{id}/duplicate

Copy a survey (questions and settings, no answers)

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Same as 200 · PATCH /v1/newsletter/engagement/surveys/{id}

4XX Default Response

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

5XX Default Response

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

POSThttps://hermeticor.com/v1/newsletter/engagement/surveys/{id}/campaign

Draft an email campaign to the survey's list, with a new template that links each recipient to the survey (signed per reader)

Parameters

idstringpathrequired

Request body

application/json

namestring

{
  "name": "string"
}

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "campaignId": "string"
}

Schema

campaignIdstringrequired

4XX Default Response

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

5XX Default Response

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

GEThttps://hermeticor.com/v1/newsletter/engagement/replies

Replies to the publication's post emails (reply-to-author inbox)

Parameters

publicationIdstringqueryrequired

unreadbooleanquery

limitintegerquery

= 50

cursorstringquery

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/newsletter/engagement/replies?publicationId=<publicationId>" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "fromAddr": "string",
      "subject": "string",
      "text": "string",
      "receivedAt": "2024-01-01T00:00:00Z",
      "profileId": "string",
      "read": true,
      "archived": true,
      "campaignId": "string"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

idstringrequired

fromAddrstringrequired

subjectstringrequired

textstringrequired

receivedAtstringrequired

profileIdstringrequired

readbooleanrequired

archivedbooleanrequired

campaignIdstringrequired

nextCursorstringrequired

4XX Default Response

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

5XX Default Response

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

Next part

Updated Nov 8, 2026

Was this page helpful?