sponsorships

Embed

<a href="https://hermeticor.com/docs/ref-sponsorships"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/35302b34-1d33-41ae-9b87-1419de376bd9/social-card.svg?v=3e7ae33eec8b" alt="sponsorships" width="600" height="315"></a>

POSThttps://hermeticor.com/v1/sponsors/network/campaigns

Create a network campaign (draft)

Request body

application/json

advertiserIdstringrequired

namestringrequired

pricingstringrequired

flat | cpm | cpc

rateMinorintegerrequired

currencystring

= USD

budgetMinorinteger

= 0

targetCategoriesstring[]

= []

minAudienceinteger

= 0

startsOnstring

endsOnstring

creativeobjectrequired

Show child parameters

sponsorstringrequired

headlinestringrequired

bodystring

imageUrlstring

= null

hrefstringrequired

ctastring

= Learn more

{
  "advertiserId": "string",
  "name": "string",
  "pricing": "flat",
  "rateMinor": 0,
  "currency": "USD",
  "budgetMinor": 0,
  "targetCategories": [],
  "minAudience": 0,
  "startsOn": "string",
  "endsOn": "string",
  "creative": {
    "sponsor": "string",
    "headline": "string",
    "body": "",
    "imageUrl": null,
    "href": "string",
    "cta": "Learn more"
  }
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/sponsors/network/campaigns" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"advertiserId":"string","name":"string","pricing":"flat","rateMinor":0,"currency":"USD","budgetMinor":0,"targetCategories":[],"minAudience":0,"startsOn":"string","endsOn":"string","creative":{"sponsor":"string","headline":"string","body":"","imageUrl":null,"href":"string","cta":"Learn more"}}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "advertiserId": "string",
  "name": "string",
  "pricing": "flat",
  "rateMinor": 0,
  "currency": "USD",
  "budgetMinor": 0,
  "targetCategories": [],
  "minAudience": 0,
  "startsOn": "string",
  "endsOn": "string",
  "creative": {
    "sponsor": "string",
    "headline": "string",
    "body": "",
    "imageUrl": null,
    "href": "string",
    "cta": "Learn more"
  },
  "id": "string",
  "advertiserName": "string",
  "status": "draft",
  "spentMinor": 0,
  "impressions": 0,
  "clicks": 0
}

Schema

advertiserIdstringrequired

namestringrequired

pricingstringrequired

flat | cpm | cpc

rateMinorintegerrequired

currencystringrequired

= USD

budgetMinorintegerrequired

= 0

targetCategoriesstring[]required

= []

minAudienceintegerrequired

= 0

startsOnstring

endsOnstring

creativeobjectrequired

Show child parameters

sponsorstringrequired

headlinestringrequired

bodystringrequired

imageUrlstringrequired

= null

hrefstringrequired

ctastringrequired

= Learn more

idstringrequired

advertiserNamestringrequired

statusstringrequired

draft | published | paused | ended

spentMinornumberrequired

impressionsnumberrequired

clicksnumberrequired

4XX Default Response

Example

{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}

Schema

errorobjectrequired

Show child parameters

codestringrequired

messagestringrequired

detailsobject

5XX Default Response

Same as 4XX · POST /v1/sponsors/network/campaigns

PUThttps://hermeticor.com/v1/sponsors/network/campaigns/{id}

Edit a draft or paused campaign

Parameters

idstringpathrequired

Request body

application/json

advertiserIdstringrequired

namestringrequired

pricingstringrequired

flat | cpm | cpc

rateMinorintegerrequired

currencystring

= USD

budgetMinorinteger

= 0

targetCategoriesstring[]

= []

minAudienceinteger

= 0

startsOnstring

endsOnstring

creativeobjectrequired

Show child parameters

sponsorstringrequired

headlinestringrequired

bodystring

imageUrlstring

= null

hrefstringrequired

ctastring

= Learn more

{
  "advertiserId": "string",
  "name": "string",
  "pricing": "flat",
  "rateMinor": 0,
  "currency": "USD",
  "budgetMinor": 0,
  "targetCategories": [],
  "minAudience": 0,
  "startsOn": "string",
  "endsOn": "string",
  "creative": {
    "sponsor": "string",
    "headline": "string",
    "body": "",
    "imageUrl": null,
    "href": "string",
    "cta": "Learn more"
  }
}

Code samples

cURL

curl -X PUT "https://hermeticor.com/v1/sponsors/network/campaigns/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"advertiserId":"string","name":"string","pricing":"flat","rateMinor":0,"currency":"USD","budgetMinor":0,"targetCategories":[],"minAudience":0,"startsOn":"string","endsOn":"string","creative":{"sponsor":"string","headline":"string","body":"","imageUrl":null,"href":"string","cta":"Learn more"}}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/sponsors/network/campaigns

4XX Default Response

Same as 4XX · POST /v1/sponsors/network/campaigns

5XX Default Response

Same as 4XX · POST /v1/sponsors/network/campaigns

POSThttps://hermeticor.com/v1/sponsors/network/campaigns/{id}/status

Publish, pause or end a campaign

Parameters

idstringpathrequired

Request body

application/json

statusstringrequired

draft | published | paused | ended

{
  "status": "draft"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/sponsors/network/campaigns/{id}/status" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"status":"draft"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/sponsors/network/campaigns

4XX Default Response

Same as 4XX · POST /v1/sponsors/network/campaigns

5XX Default Response

Same as 4XX · POST /v1/sponsors/network/campaigns

GEThttps://hermeticor.com/v1/sponsors/network/marketplace

Published network campaigns for a publication, with your decision and whether targeting fits

Parameters

publicationIdstringqueryrequired

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/sponsors/network/marketplace?publicationId=<publicationId>" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "advertiser": "string",
      "name": "string",
      "pricing": "flat",
      "rateMinor": 0,
      "currency": "string",
      "targetCategories": [
        "string"
      ],
      "minAudience": 0,
      "startsOn": "string",
      "endsOn": "string",
      "creative": {
        "sponsor": "string",
        "headline": "string",
        "body": "",
        "imageUrl": null,
        "href": "string",
        "cta": "Learn more"
      },
      "decision": "accepted",
      "eligible": true,
      "reason": "string"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

idstringrequired

advertiserstringrequired

namestringrequired

pricingstringrequired

flat | cpm | cpc

rateMinornumberrequired

currencystringrequired

targetCategoriesstring[]required

minAudiencenumberrequired

startsOnstringrequired

endsOnstringrequired

creativeobjectrequired

Show child parameters

sponsorstringrequired

headlinestringrequired

bodystringrequired

imageUrlstringrequired

= null

hrefstringrequired

ctastringrequired

= Learn more

decisionstringrequired

accepted | declined

eligiblebooleanrequired

reasonstringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · POST /v1/sponsors/network/campaigns

5XX Default Response

Same as 4XX · POST /v1/sponsors/network/campaigns

POSThttps://hermeticor.com/v1/sponsors/network/marketplace/{id}/decision

Accept or decline a network campaign for a publication

Parameters

idstringpathrequired

Request body

application/json

publicationIdstringrequired

decisionstringrequired

accepted | declined

{
  "publicationId": "string",
  "decision": "accepted"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/sponsors/network/marketplace/{id}/decision" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"publicationId":"string","decision":"accepted"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "ok": true
}

Schema

okbooleanrequired

true

4XX Default Response

Same as 4XX · POST /v1/sponsors/network/campaigns

5XX Default Response

Same as 4XX · POST /v1/sponsors/network/campaigns

GEThttps://hermeticor.com/v1/sponsors/network/earnings

Earnings ledger (earned, approved, paid). Hermeticor does not move money: mark entries paid after the advertiser pays you

Parameters

statusstringquery

earned | approved | paid

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/sponsors/network/earnings" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "placementId": "string",
      "campaignId": "string",
      "campaign": "string",
      "publicationId": "string",
      "impressions": 0,
      "clicks": 0,
      "amountMinor": 0,
      "currency": "string",
      "status": "earned",
      "paidAt": "string",
      "paidNote": "string",
      "createdAt": "string"
    }
  ],
  "summary": {
    "earnedMinor": 0,
    "approvedMinor": 0,
    "paidMinor": 0,
    "currency": "string"
  }
}

Schema

itemsobject[]required

Show child parameters

idstringrequired

placementIdstringrequired

campaignIdstringrequired

campaignstringrequired

publicationIdstringrequired

impressionsnumberrequired

clicksnumberrequired

amountMinornumberrequired

currencystringrequired

statusstringrequired

earned | approved | paid

paidAtstringrequired

paidNotestringrequired

createdAtstringrequired

summaryobjectrequired

Show child parameters

earnedMinornumberrequired

approvedMinornumberrequired

paidMinornumberrequired

currencystringrequired

4XX Default Response

Same as 4XX · POST /v1/sponsors/network/campaigns

5XX Default Response

Same as 4XX · POST /v1/sponsors/network/campaigns

Next part

Updated Nov 8, 2026

Was this page helpful?