newsletter-growth

Embed

<a href="https://hermeticor.com/docs/ref-newsletter-growth"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/9146c49f-fdeb-4eb6-9b41-8433f17c6781/social-card.svg?v=3e7ae33eec8b" alt="newsletter-growth" width="600" height="315"></a>

GEThttps://hermeticor.com/v1/newsletter/growth/surfaces/{publicationId}

Subscribe page, embed and popup settings for a publication (null until saved)

Parameters

publicationIdstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "listId": "string",
  "enabled": true,
  "headline": "string",
  "blurb": "",
  "buttonLabel": "Subscribe",
  "consentText": "string",
  "popup": {
    "mode": "off",
    "delaySeconds": 8,
    "scrollPercent": 0,
    "frequencyDays": 7,
    "headline": ""
  },
  "scroll": {
    "enabled": false,
    "percent": 60
  },
  "publicationId": "string",
  "hostedUrl": "string",
  "embedSnippet": "string"
}

Schema

listIdstringrequired

enabledbooleanrequired

= true

headlinestringrequired

blurbstringrequired

buttonLabelstringrequired

= Subscribe

consentTextstringrequired

popupobjectrequired

= {"mode":"off","delaySeconds":8,"scrollPercent":0,"frequencyDays":7,"headline":""}

Show child parameters

modestringrequired

off | popup | slide_in = off

delaySecondsintegerrequired

= 8

scrollPercentintegerrequired

= 0

frequencyDaysintegerrequired

= 7

headlinestringrequired

scrollobjectrequired

= {"enabled":false,"percent":60}

Show child parameters

enabledbooleanrequired

= false

percentintegerrequired

= 60

publicationIdstringrequired

hostedUrlstringrequired

embedSnippetstringrequired

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/growth/surfaces/{publicationId}

PUThttps://hermeticor.com/v1/newsletter/growth/surfaces/{publicationId}

Parameters

publicationIdstringpathrequired

Request body

application/json

listIdstringrequired

enabledboolean

= true

headlinestringrequired

blurbstring

buttonLabelstring

= Subscribe

consentTextstringrequired

popupobject

= {"mode":"off","delaySeconds":8,"scrollPercent":0,"frequencyDays":7,"headline":""}

Show child parameters

modestring

off | popup | slide_in = off

delaySecondsinteger

= 8

scrollPercentinteger

= 0

frequencyDaysinteger

= 7

headlinestring

scrollobject

= {"enabled":false,"percent":60}

Show child parameters

enabledboolean

= false

percentinteger

= 60

{
  "listId": "string",
  "enabled": true,
  "headline": "string",
  "blurb": "",
  "buttonLabel": "Subscribe",
  "consentText": "string",
  "popup": {
    "mode": "off",
    "delaySeconds": 8,
    "scrollPercent": 0,
    "frequencyDays": 7,
    "headline": ""
  },
  "scroll": {
    "enabled": false,
    "percent": 60
  }
}

Code samples

cURL

curl -X PUT "https://hermeticor.com/v1/newsletter/growth/surfaces/{publicationId}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"listId":"string","enabled":true,"headline":"string","blurb":"","buttonLabel":"Subscribe","consentText":"string","popup":{"mode":"off","delaySeconds":8,"scrollPercent":0,"frequencyDays":7,"headline":""},"scroll":{"enabled":false,"percent":60}}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · GET /v1/newsletter/growth/surfaces/{publicationId}

4XX Default Response

Same as 4XX · GET /v1/newsletter/growth/surfaces/{publicationId}

5XX Default Response

Same as 4XX · GET /v1/newsletter/growth/surfaces/{publicationId}

GEThttps://hermeticor.com/v1/newsletter/growth/referrals/{publicationId}

Parameters

publicationIdstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "enabled": true,
  "programId": "string",
  "pending": 0,
  "counted": 0,
  "flagged": 0,
  "milestones": [
    {
      "threshold": 0,
      "rewardKind": "download",
      "rewardLabel": "string",
      "rewardValue": "",
      "id": "string",
      "awarded": 0
    }
  ]
}

Schema

enabledbooleanrequired

programIdstringrequired

pendingintegerrequired

countedintegerrequired

flaggedintegerrequired

milestonesMilestonesItem[]required

Show child parameters

thresholdintegerrequired

rewardKindstringrequired

download | coupon | merch | paid_comp

rewardLabelstringrequired

rewardValuestringrequired

idstringrequired

awardedintegerrequired

4XX Default Response

Same as 4XX · GET /v1/newsletter/growth/surfaces/{publicationId}

5XX Default Response

Same as 4XX · GET /v1/newsletter/growth/surfaces/{publicationId}

PUThttps://hermeticor.com/v1/newsletter/growth/referrals/{publicationId}

Turn the newsletter referral program on or off

Parameters

publicationIdstringpathrequired

Request body

application/json

enabledboolean

= true

cookieDaysinteger

= 30

{
  "enabled": true,
  "cookieDays": 30
}

Code samples

cURL

curl -X PUT "https://hermeticor.com/v1/newsletter/growth/referrals/{publicationId}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"enabled":true,"cookieDays":30}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · GET /v1/newsletter/growth/referrals/{publicationId}

4XX Default Response

Same as 4XX · GET /v1/newsletter/growth/surfaces/{publicationId}

5XX Default Response

Same as 4XX · GET /v1/newsletter/growth/surfaces/{publicationId}

POSThttps://hermeticor.com/v1/newsletter/growth/referrals/{publicationId}/milestones

Add or update the reward for a referral count

Parameters

publicationIdstringpathrequired

Request body

application/json

thresholdintegerrequired

rewardKindstringrequired

download | coupon | merch | paid_comp

rewardLabelstringrequired

rewardValuestring

{
  "threshold": 0,
  "rewardKind": "download",
  "rewardLabel": "string",
  "rewardValue": ""
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/newsletter/growth/referrals/{publicationId}/milestones" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"threshold":0,"rewardKind":"download","rewardLabel":"string","rewardValue":""}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "threshold": 0,
  "rewardKind": "download",
  "rewardLabel": "string",
  "rewardValue": "",
  "id": "string",
  "awarded": 0
}

Schema

thresholdintegerrequired

rewardKindstringrequired

download | coupon | merch | paid_comp

rewardLabelstringrequired

rewardValuestringrequired

idstringrequired

awardedintegerrequired

4XX Default Response

Same as 4XX · GET /v1/newsletter/growth/surfaces/{publicationId}

5XX Default Response

Same as 4XX · GET /v1/newsletter/growth/surfaces/{publicationId}

DELETEhttps://hermeticor.com/v1/newsletter/growth/referrals/{publicationId}/milestones/{id}

Parameters

publicationIdstringpathrequired

idstringpathrequired

Code samples

cURL

curl -X DELETE "https://hermeticor.com/v1/newsletter/growth/referrals/{publicationId}/milestones/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "ok": true
}

Schema

okbooleanrequired

true

4XX Default Response

Same as 4XX · GET /v1/newsletter/growth/surfaces/{publicationId}

5XX Default Response

Same as 4XX · GET /v1/newsletter/growth/surfaces/{publicationId}

GEThttps://hermeticor.com/v1/newsletter/growth/referrals/{publicationId}/leaderboard

Parameters

limitintegerquery

Page size; omitted returns the whole list

cursorstringquery

Opaque: the nextCursor of the previous page

publicationIdstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/newsletter/growth/referrals/{publicationId}/leaderboard" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "profileId": "string",
      "name": "string",
      "counted": 0,
      "pending": 0,
      "flagged": 0
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

profileIdstringrequired

namestringrequired

countedintegerrequired

pendingintegerrequired

flaggedintegerrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · GET /v1/newsletter/growth/surfaces/{publicationId}

5XX Default Response

Same as 4XX · GET /v1/newsletter/growth/surfaces/{publicationId}

Next part

Updated Nov 8, 2026

Was this page helpful?