sponsorships

Embed
Preview of the card
<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>
GEThttps://hermeticor.com/v1/sponsors/publications/{publicationId}/rules

Ad slot rules of a publication

Parameters

publicationIdstringpathrequired

Code samples

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

Responses

200 Default Response
Example
{
  "maxAdsPerIssue": 0,
  "slots": [
    "string"
  ],
  "autoFill": true,
  "allowNetwork": true
}
Schema
maxAdsPerIssueintegerrequired
slotsstring[]required
autoFillbooleanrequired
allowNetworkbooleanrequired
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/sponsors/publications/{publicationId}/rules

PUThttps://hermeticor.com/v1/sponsors/publications/{publicationId}/rules

Set max ads per issue, allowed slots, auto-fill and ad network use

Parameters

publicationIdstringpathrequired

Request body

application/json
maxAdsPerIssueintegerrequired
slotsstring[]required
autoFillbooleanrequired
allowNetworkbooleanrequired
{
  "maxAdsPerIssue": 0,
  "slots": [
    "string"
  ],
  "autoFill": true,
  "allowNetwork": true
}

Code samples

cURL
curl -X PUT "https://hermeticor.com/v1/sponsors/publications/{publicationId}/rules" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"maxAdsPerIssue":0,"slots":["string"],"autoFill":true,"allowNetwork":true}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 200 · GET /v1/sponsors/publications/{publicationId}/rules

4XX Default Response

Same as 4XX · GET /v1/sponsors/publications/{publicationId}/rules

5XX Default Response

Same as 4XX · GET /v1/sponsors/publications/{publicationId}/rules

GEThttps://hermeticor.com/v1/sponsors/publications/{publicationId}/media-kit

Rate card / media kit of a publication (null until saved)

Parameters

publicationIdstringpathrequired

Code samples

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

Responses

200 Default Response
Example
{
  "slug": "string",
  "title": "string",
  "description": "",
  "audienceSize": 0,
  "openRatePct": 0,
  "categories": [
    "string"
  ],
  "prices": [
    {
      "label": "string",
      "slot": "string",
      "pricing": "flat",
      "priceMinor": 0
    }
  ],
  "currency": "USD",
  "contactEmail": "string",
  "published": true,
  "publicationId": "string",
  "url": "string",
  "live": {
    "audienceSize": 0,
    "openRatePct": 0
  }
}
Schema
slugstringrequired
titlestringrequired
descriptionstringrequired
audienceSizeintegerrequired
openRatePctnumberrequired
categoriesstring[]required
pricesPricesItem[]required
Show child parameters
labelstringrequired
slotstringrequired
pricingstringrequired
flat | cpm | cpc
priceMinorintegerrequired
currencystringrequired
= USD
contactEmailstring
publishedbooleanrequired
publicationIdstringrequired
urlstringrequired
liveobjectrequired
Show child parameters
audienceSizeintegerrequired
openRatePctnumberrequired
4XX Default Response

Same as 4XX · GET /v1/sponsors/publications/{publicationId}/rules

5XX Default Response

Same as 4XX · GET /v1/sponsors/publications/{publicationId}/rules

PUThttps://hermeticor.com/v1/sponsors/publications/{publicationId}/media-kit

Save the rate card; publishing it makes the public page live

Parameters

publicationIdstringpathrequired

Request body

application/json
slugstringrequired
titlestringrequired
descriptionstring
audienceSizeintegerrequired
openRatePctnumberrequired
categoriesstring[]required
pricesobject[]required
Show child parameters
labelstringrequired
slotstringrequired
pricingstringrequired
flat | cpm | cpc
priceMinorintegerrequired
currencystring
= USD
contactEmailstring
publishedbooleanrequired
{
  "slug": "string",
  "title": "string",
  "description": "",
  "audienceSize": 0,
  "openRatePct": 0,
  "categories": [
    "string"
  ],
  "prices": [
    {
      "label": "string",
      "slot": "string",
      "pricing": "flat",
      "priceMinor": 0
    }
  ],
  "currency": "USD",
  "contactEmail": "string",
  "published": true
}

Code samples

cURL
curl -X PUT "https://hermeticor.com/v1/sponsors/publications/{publicationId}/media-kit" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"slug":"string","title":"string","description":"","audienceSize":0,"openRatePct":0,"categories":["string"],"prices":[{"label":"string","slot":"string","pricing":"flat","priceMinor":0}],"currency":"USD","contactEmail":"string","published":true}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 200 · GET /v1/sponsors/publications/{publicationId}/media-kit

4XX Default Response

Same as 4XX · GET /v1/sponsors/publications/{publicationId}/rules

5XX Default Response

Same as 4XX · GET /v1/sponsors/publications/{publicationId}/rules

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

Your advertiser profiles on the ad network

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

Responses

200 Default Response
Example
{
  "items": [
    {
      "name": "string",
      "website": "string",
      "logoUrl": "string",
      "id": "string"
    }
  ],
  "nextCursor": "string"
}
Schema
itemsItemsItem200[]required
Show child parameters
namestringrequired
websitestring
logoUrlstring
idstringrequired
nextCursorstringrequired
4XX Default Response

Same as 4XX · GET /v1/sponsors/publications/{publicationId}/rules

5XX Default Response

Same as 4XX · GET /v1/sponsors/publications/{publicationId}/rules

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

Create an advertiser profile to run network campaigns

Request body

application/json
namestringrequired
websitestring
logoUrlstring
{
  "name": "string",
  "website": "string",
  "logoUrl": "string"
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/sponsors/network/advertisers" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","website":"string","logoUrl":"string"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

201 Default Response
Example
{
  "name": "string",
  "website": "string",
  "logoUrl": "string",
  "id": "string"
}
Schema
namestringrequired
websitestring
logoUrlstring
idstringrequired
4XX Default Response

Same as 4XX · GET /v1/sponsors/publications/{publicationId}/rules

5XX Default Response

Same as 4XX · GET /v1/sponsors/publications/{publicationId}/rules

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

Network campaigns you run as an advertiser

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

Responses

200 Default Response
Example
{
  "items": [
    {
      "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
    }
  ],
  "nextCursor": "string"
}
Schema
itemsItemsItem201[]required
Show child parameters
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
nextCursorstringrequired
4XX Default Response

Same as 4XX · GET /v1/sponsors/publications/{publicationId}/rules

5XX Default Response

Same as 4XX · GET /v1/sponsors/publications/{publicationId}/rules

Updated