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>

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

Advertisers you sell ads to

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/advertisers" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "name": "string",
      "contactName": "string",
      "contactEmail": "string",
      "website": "string",
      "logoUrl": "string",
      "notes": "string",
      "id": "string",
      "archived": true,
      "createdAt": "string"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem197[]required

Show child parameters

namestringrequired

contactNamestring

contactEmailstring

websitestring

logoUrlstring

notesstring

idstringrequired

archivedbooleanrequired

createdAtstringrequired

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/sponsors/advertisers

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

Add an advertiser

Request body

application/json

namestringrequired

contactNamestring

contactEmailstring

websitestring

logoUrlstring

notesstring

{
  "name": "string",
  "contactName": "string",
  "contactEmail": "string",
  "website": "string",
  "logoUrl": "string",
  "notes": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/sponsors/advertisers" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","contactName":"string","contactEmail":"string","website":"string","logoUrl":"string","notes":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "name": "string",
  "contactName": "string",
  "contactEmail": "string",
  "website": "string",
  "logoUrl": "string",
  "notes": "string",
  "id": "string",
  "archived": true,
  "createdAt": "string"
}

Schema

namestringrequired

contactNamestring

contactEmailstring

websitestring

logoUrlstring

notesstring

idstringrequired

archivedbooleanrequired

createdAtstringrequired

4XX Default Response

Same as 4XX · GET /v1/sponsors/advertisers

5XX Default Response

Same as 4XX · GET /v1/sponsors/advertisers

PATCHhttps://hermeticor.com/v1/sponsors/advertisers/{id}

Edit an advertiser

Parameters

idstringpathrequired

Request body

application/json

namestring

contactNamestring

contactEmailstring

websitestring

logoUrlstring

notesstring

{
  "name": "string",
  "contactName": "string",
  "contactEmail": "string",
  "website": "string",
  "logoUrl": "string",
  "notes": "string"
}

Code samples

cURL

curl -X PATCH "https://hermeticor.com/v1/sponsors/advertisers/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","contactName":"string","contactEmail":"string","website":"string","logoUrl":"string","notes":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/sponsors/advertisers

4XX Default Response

Same as 4XX · GET /v1/sponsors/advertisers

5XX Default Response

Same as 4XX · GET /v1/sponsors/advertisers

POSThttps://hermeticor.com/v1/sponsors/advertisers/{id}/archive

Archive or restore an advertiser

Parameters

idstringpathrequired

Request body

application/json

archivedbooleanrequired

{
  "archived": true
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/sponsors/advertisers/{id}/archive" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"archived":true}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/sponsors/advertisers

4XX Default Response

Same as 4XX · GET /v1/sponsors/advertisers

5XX Default Response

Same as 4XX · GET /v1/sponsors/advertisers

GEThttps://hermeticor.com/v1/sponsors/bookings

Sponsor bookings

Parameters

statusstringquery

publicationIdstringquery

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/bookings" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "advertiserId": "string",
      "advertiserName": "string",
      "publicationId": "string",
      "name": "string",
      "slot": "string",
      "channel": "email",
      "startsOn": "string",
      "endsOn": "string",
      "pricing": "flat",
      "priceMinor": 0,
      "currency": "string",
      "status": "proposed",
      "notes": "string",
      "reportUrl": "string",
      "createdAt": "string"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem198[]required

Show child parameters

idstringrequired

advertiserIdstringrequired

advertiserNamestringrequired

publicationIdstringrequired

namestringrequired

slotstringrequired

channelstringrequired

email | web | both

startsOnstringrequired

endsOnstringrequired

pricingstringrequired

flat | cpm | cpc

priceMinornumberrequired

currencystringrequired

statusstringrequired

notesstringrequired

reportUrlstringrequired

createdAtstringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · GET /v1/sponsors/advertisers

5XX Default Response

Same as 4XX · GET /v1/sponsors/advertisers

POSThttps://hermeticor.com/v1/sponsors/bookings

Create a booking (starts as proposed)

Request body

application/json

advertiserIdstringrequired

publicationIdstringrequired

namestringrequired

slotstring

= top

channelstring

email | web | both = both

startsOnstringrequired

endsOnstringrequired

pricingstring

flat | cpm | cpc = flat

priceMinorintegerrequired

currencystring

= USD

notesstring

{
  "advertiserId": "string",
  "publicationId": "string",
  "name": "string",
  "slot": "top",
  "channel": "both",
  "startsOn": "string",
  "endsOn": "string",
  "pricing": "flat",
  "priceMinor": 0,
  "currency": "USD",
  "notes": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/sponsors/bookings" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"advertiserId":"string","publicationId":"string","name":"string","slot":"top","channel":"both","startsOn":"string","endsOn":"string","pricing":"flat","priceMinor":0,"currency":"USD","notes":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "id": "string",
  "advertiserId": "string",
  "advertiserName": "string",
  "publicationId": "string",
  "name": "string",
  "slot": "string",
  "channel": "email",
  "startsOn": "string",
  "endsOn": "string",
  "pricing": "flat",
  "priceMinor": 0,
  "currency": "string",
  "status": "proposed",
  "notes": "string",
  "reportUrl": "string",
  "createdAt": "string"
}

Schema

idstringrequired

advertiserIdstringrequired

advertiserNamestringrequired

publicationIdstringrequired

namestringrequired

slotstringrequired

channelstringrequired

email | web | both

startsOnstringrequired

endsOnstringrequired

pricingstringrequired

flat | cpm | cpc

priceMinornumberrequired

currencystringrequired

statusstringrequired

notesstringrequired

reportUrlstringrequired

createdAtstringrequired

4XX Default Response

Same as 4XX · GET /v1/sponsors/advertisers

5XX Default Response

Same as 4XX · GET /v1/sponsors/advertisers

GEThttps://hermeticor.com/v1/sponsors/bookings/{id}

One booking

Parameters

idstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/sponsors/bookings/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/sponsors/bookings

4XX Default Response

Same as 4XX · GET /v1/sponsors/advertisers

5XX Default Response

Same as 4XX · GET /v1/sponsors/advertisers

PATCHhttps://hermeticor.com/v1/sponsors/bookings/{id}

Edit a proposed or approved booking

Parameters

idstringpathrequired

Request body

application/json

advertiserIdstring

publicationIdstring

namestring

slotstring

channelstring

email | web | both

startsOnstring

endsOnstring

pricingstring

flat | cpm | cpc

priceMinorinteger

currencystring

notesstring

{
  "advertiserId": "string",
  "publicationId": "string",
  "name": "string",
  "slot": "string",
  "channel": "email",
  "startsOn": "string",
  "endsOn": "string",
  "pricing": "flat",
  "priceMinor": 0,
  "currency": "string",
  "notes": "string"
}

Code samples

cURL

curl -X PATCH "https://hermeticor.com/v1/sponsors/bookings/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"advertiserId":"string","publicationId":"string","name":"string","slot":"string","channel":"email","startsOn":"string","endsOn":"string","pricing":"flat","priceMinor":0,"currency":"string","notes":"string"}'

TypeScript

Python

PHP

Ruby

Java