newsletter-boosts

Embed

<a href="https://hermeticor.com/docs/ref-newsletter-boosts"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/27e4ff06-8560-4fc7-a813-2b7887cbe442/social-card.svg?v=3e7ae33eec8b" alt="newsletter-boosts" width="600" height="315"></a>

GEThttps://hermeticor.com/v1/newsletter/boosts/offers

Boost marketplace: open offers and your own

Parameters

limitintegerquery

Page size; omitted returns the whole list

cursorstringquery

Opaque: the nextCursor of the previous page

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/newsletter/boosts/offers" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "workspaceId": "string",
      "publicationId": "string",
      "title": "string",
      "description": "string",
      "bountyMinor": 0,
      "currency": "string",
      "holdDays": 0,
      "maxConversions": 0,
      "status": "string",
      "mine": true,
      "myApplication": "string",
      "conversions": 0
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem196[]required

Show child parameters

idstringrequired

workspaceIdstringrequired

publicationIdstringrequired

titlestringrequired

descriptionstringrequired

bountyMinorintegerrequired

currencystringrequired

holdDaysintegerrequired

maxConversionsintegerrequired

statusstringrequired

minebooleanrequired

myApplicationstringrequired

conversionsintegerrequired

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/boosts/offers

POSThttps://hermeticor.com/v1/newsletter/boosts/offers

Offer a bounty per confirmed, retained subscriber

Request body

application/json

publicationIdstringrequired

titlestringrequired

descriptionstring

bountyMinorintegerrequired

currencystring

= USD

holdDaysinteger

= 30

maxConversionsinteger

statusstring

open | paused | closed = open

{
  "publicationId": "string",
  "title": "string",
  "description": "",
  "bountyMinor": 0,
  "currency": "USD",
  "holdDays": 30,
  "maxConversions": 0,
  "status": "open"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/newsletter/boosts/offers" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"publicationId":"string","title":"string","description":"","bountyMinor":0,"currency":"USD","holdDays":30,"maxConversions":0,"status":"open"}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "id": "string",
  "workspaceId": "string",
  "publicationId": "string",
  "title": "string",
  "description": "string",
  "bountyMinor": 0,
  "currency": "string",
  "holdDays": 0,
  "maxConversions": 0,
  "status": "string",
  "mine": true,
  "myApplication": "string",
  "conversions": 0
}

Schema

idstringrequired

workspaceIdstringrequired

publicationIdstringrequired

titlestringrequired

descriptionstringrequired

bountyMinorintegerrequired

currencystringrequired

holdDaysintegerrequired

maxConversionsintegerrequired

statusstringrequired

minebooleanrequired

myApplicationstringrequired

conversionsintegerrequired

4XX Default Response

Same as 4XX · GET /v1/newsletter/boosts/offers

5XX Default Response

Same as 4XX · GET /v1/newsletter/boosts/offers

PATCHhttps://hermeticor.com/v1/newsletter/boosts/offers/{id}

Parameters

idstringpathrequired

Request body

application/json

titlestring

descriptionstring

bountyMinorinteger

currencystring

holdDaysinteger

maxConversionsinteger

statusstring

open | paused | closed

{
  "title": "string",
  "description": "string",
  "bountyMinor": 0,
  "currency": "string",
  "holdDays": 0,
  "maxConversions": 0,
  "status": "open"
}

Code samples

cURL

curl -X PATCH "https://hermeticor.com/v1/newsletter/boosts/offers/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"title":"string","description":"string","bountyMinor":0,"currency":"string","holdDays":0,"maxConversions":0,"status":"open"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/newsletter/boosts/offers

4XX Default Response

Same as 4XX · GET /v1/newsletter/boosts/offers

5XX Default Response

Same as 4XX · GET /v1/newsletter/boosts/offers

POSThttps://hermeticor.com/v1/newsletter/boosts/offers/{id}/apply

Apply to promote an offer

Parameters

idstringpathrequired

Request body

application/json

partnerPublicationIdstringrequired

partnerNamestringrequired

promostringrequired

recommendation_slot | boost_link

messagestring

{
  "partnerPublicationId": "string",
  "partnerName": "string",
  "promo": "recommendation_slot",
  "message": ""
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/newsletter/boosts/offers/{id}/apply" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"partnerPublicationId":"string","partnerName":"string","promo":"recommendation_slot","message":""}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "id": "string",
  "status": "string"
}

Schema

idstringrequired

statusstringrequired

4XX Default Response

Same as 4XX · GET /v1/newsletter/boosts/offers

5XX Default Response

Same as 4XX · GET /v1/newsletter/boosts/offers

GEThttps://hermeticor.com/v1/newsletter/boosts/applications

Applications to your offers (received) or that you sent

Parameters

sidestringquery

received | sent = received

limitintegerquery

Page size; omitted returns the whole list

cursorstringquery

Opaque: the nextCursor of the previous page

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/newsletter/boosts/applications" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "offerId": "string",
      "offerTitle": "string",
      "partnerWorkspaceId": "string",
      "partnerName": "string",
      "promo": "string",
      "status": "string",
      "message": "string",
      "link": "string",
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

idstringrequired

offerIdstringrequired

offerTitlestringrequired

partnerWorkspaceIdstringrequired

partnerNamestringrequired

promostringrequired

statusstringrequired

messagestringrequired

linkstringrequired

createdAtstringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · GET /v1/newsletter/boosts/offers

5XX Default Response

Same as 4XX · GET /v1/newsletter/boosts/offers

POSThttps://hermeticor.com/v1/newsletter/boosts/applications/{id}/decision

Parameters

idstringpathrequired

Request body

application/json

decisionstringrequired

approve | reject | end

{
  "decision": "approve"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/newsletter/boosts/applications/{id}/decision" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"decision":"approve"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "id": "string",
  "status": "string",
  "code": "string"
}

Schema

idstringrequired

statusstringrequired

codestringrequired

4XX Default Response

Same as 4XX · GET /v1/newsletter/boosts/offers

5XX Default Response

Same as 4XX · GET /v1/newsletter/boosts/offers

GEThttps://hermeticor.com/v1/newsletter/boosts/ledger

Ledger and report for either side of a boost. No money moves through Hermeticor.

Parameters

sidestringquery

advertiser | partner = advertiser

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/newsletter/boosts/ledger" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "side": "advertiser",
  "totals": {
    "pending": 0,
    "held": 0,
    "payable": 0,
    "paid": 0,
    "void": 0,
    "conversions": 0
  },
  "currency": "string",
  "items": [
    {
      "id": "string",
      "applicationId": "string",
      "offerTitle": "string",
      "partnerName": "string",
      "amountMinor": 0,
      "currency": "string",
      "status": "pending",
      "holdUntil": "2024-01-01T00:00:00Z",
      "createdAt": "2024-01-01T00:00:00Z",
      "paidAt": "2024-01-01T00:00:00Z"
    }
  ],
  "note": "string"
}

Schema

sidestringrequired

advertiser | partner

totalsobjectrequired

Show child parameters

pendingintegerrequired

heldintegerrequired

payableintegerrequired

paidintegerrequired

voidintegerrequired

conversionsintegerrequired

currencystringrequired

itemsobject[]required

Show child parameters

idstringrequired

applicationIdstringrequired

offerTitlestringrequired

partnerNamestringrequired

amountMinorintegerrequired

currencystringrequired

statusstringrequired

pending | held | payable | paid | void

holdUntilstringrequired

createdAtstringrequired

paidAtstringrequired

notestringrequired

4XX Default Response

Same as 4XX · GET /v1/newsletter/boosts/offers

5XX Default Response

Same as 4XX · GET /v1/newsletter/boosts/offers

POSThttps://hermeticor.com/v1/newsletter/boosts/ledger/{id}/paid

Record that a payable line was settled outside Hermeticor

Parameters

idstringpathrequired

Request body

application/json

notestring

{
  "note": ""
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/newsletter/boosts/ledger/{id}/paid" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"note":""}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "ok": true
}

Schema

okbooleanrequired

true

4XX Default Response

Same as 4XX · GET /v1/newsletter/boosts/offers

5XX Default Response

Same as 4XX · GET /v1/newsletter/boosts/offers

Updated Nov 8, 2026

Was this page helpful?