newsletter-growth

Embed
Preview of the card
<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/referrals/{publicationId}/awards

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}/awards" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "items": [
    {
      "id": "string",
      "profileId": "string",
      "name": "string",
      "milestoneLabel": "string",
      "threshold": 0,
      "rewardKind": "string",
      "awardedAt": "2024-01-01T00:00:00Z",
      "fulfilledAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}
Schema
itemsobject[]required
Show child parameters
idstringrequired
profileIdstringrequired
namestringrequired
milestoneLabelstringrequired
thresholdintegerrequired
rewardKindstringrequired
awardedAtstringrequired
fulfilledAtstringrequired
nextCursorstringrequired
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/referrals/{publicationId}/awards

POSThttps://hermeticor.com/v1/newsletter/growth/referrals/{publicationId}/awards/{id}/fulfilled

Mark a hand-fulfilled reward (merch, paid comp) as delivered

Parameters

publicationIdstringpathrequired
idstringpathrequired

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/newsletter/growth/referrals/{publicationId}/awards/{id}/fulfilled" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

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

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

5XX Default Response

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

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

Browse the recommendations directory

Parameters

qstringquery
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/directory/{publicationId}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "items": [
    {
      "id": "string",
      "workspaceId": "string",
      "publicationId": "string",
      "name": "string",
      "tagline": "string",
      "category": "string",
      "logoUrl": "string",
      "recommendedBy": 0,
      "recommending": 0,
      "mine": true,
      "recommended": true
    }
  ],
  "nextCursor": "string"
}
Schema
itemsobject[]required
Show child parameters
idstringrequired
workspaceIdstringrequired
publicationIdstringrequired
namestringrequired
taglinestringrequired
categorystringrequired
logoUrlstringrequired
recommendedByintegerrequired
recommendingintegerrequired
minebooleanrequired
recommendedbooleanrequired
nextCursorstringrequired
4XX Default Response

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

5XX Default Response

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

DELETEhttps://hermeticor.com/v1/newsletter/growth/directory/{publicationId}

Leave the directory and withdraw your recommendations

Parameters

publicationIdstringpathrequired

Code samples

cURL
curl -X DELETE "https://hermeticor.com/v1/newsletter/growth/directory/{publicationId}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 200 · POST /v1/newsletter/growth/referrals/{publicationId}/awards/{id}/fulfilled

4XX Default Response

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

5XX Default Response

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

PUThttps://hermeticor.com/v1/newsletter/growth/directory

Join the directory (publishes the name, tagline, category and logo given)

Request body

application/json
publicationIdstringrequired
namestringrequired
taglinestring
categorystring
logoUrlstring
{
  "publicationId": "string",
  "name": "string",
  "tagline": "",
  "category": "",
  "logoUrl": "string"
}

Code samples

cURL
curl -X PUT "https://hermeticor.com/v1/newsletter/growth/directory" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"publicationId":"string","name":"string","tagline":"","category":"","logoUrl":"string"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 200 · POST /v1/newsletter/growth/referrals/{publicationId}/awards/{id}/fulfilled

4XX Default Response

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

5XX Default Response

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

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

Parameters

publicationIdstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/newsletter/growth/recommendations/{publicationId}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "listing": {
    "id": "string",
    "workspaceId": "string",
    "publicationId": "string",
    "name": "string",
    "tagline": "string",
    "category": "string",
    "logoUrl": "string",
    "recommendedBy": 0,
    "recommending": 0,
    "mine": true,
    "recommended": true
  },
  "outgoing": [
    {
      "id": "string",
      "listingId": "string",
      "name": "string",
      "tagline": "string",
      "sent": 0,
      "views": 0
    }
  ],
  "incoming": 0,
  "incomingSubscribes": 0
}
Schema
listingobjectrequired
Show child parameters
idstringrequired
workspaceIdstringrequired
publicationIdstringrequired
namestringrequired
taglinestringrequired
categorystringrequired
logoUrlstringrequired
recommendedByintegerrequired
recommendingintegerrequired
minebooleanrequired
recommendedbooleanrequired
outgoingobject[]required
Show child parameters
idstringrequired
listingIdstringrequired
namestringrequired
taglinestringrequired
sentintegerrequired
viewsintegerrequired
incomingintegerrequired
incomingSubscribesintegerrequired
4XX Default Response

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

5XX Default Response

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

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

Parameters

publicationIdstringpathrequired

Request body

application/json
listingIdstringrequired
{
  "listingId": "string"
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/newsletter/growth/recommendations/{publicationId}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"listingId":"string"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 200 · POST /v1/newsletter/growth/referrals/{publicationId}/awards/{id}/fulfilled

4XX Default Response

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

5XX Default Response

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

DELETEhttps://hermeticor.com/v1/newsletter/growth/recommendations/{publicationId}/{listingId}

Parameters

publicationIdstringpathrequired
listingIdstringpathrequired

Code samples

cURL
curl -X DELETE "https://hermeticor.com/v1/newsletter/growth/recommendations/{publicationId}/{listingId}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 200 · POST /v1/newsletter/growth/referrals/{publicationId}/awards/{id}/fulfilled

4XX Default Response

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

5XX Default Response

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

Updated