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/bookings/{id}/move

Move a booking to its next status (proposed, approved, scheduled, run, invoiced, paid) or cancel it

Parameters

idstringpathrequired

Request body

application/json

tostringrequired

{
  "to": "proposed"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/sponsors/bookings/{id}/move" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"to":"proposed"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 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

Example

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

Schema

errorobjectrequired

Show child parameters

codestringrequired

messagestringrequired

detailsobject

5XX Default Response

Same as 4XX · POST /v1/sponsors/bookings/{id}/move

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

Creatives of a booking

Parameters

limitintegerquery

Page size; omitted returns the whole list

cursorstringquery

Opaque: the nextCursor of the previous page

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "headline": "string",
      "body": "",
      "imageUrl": null,
      "href": "string",
      "cta": "Learn more",
      "id": "string",
      "bookingId": "string",
      "status": "draft",
      "reviewNote": "string",
      "decidedAt": "string"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem199[]required

Show child parameters

headlinestringrequired

bodystringrequired

imageUrlstringrequired

= null

hrefstringrequired

ctastringrequired

= Learn more

idstringrequired

bookingIdstringrequired

statusstringrequired

draft | pending | approved | rejected

reviewNotestringrequired

decidedAtstringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · POST /v1/sponsors/bookings/{id}/move

5XX Default Response

Same as 4XX · POST /v1/sponsors/bookings/{id}/move

POSThttps://hermeticor.com/v1/sponsors/bookings/{id}/creatives

Add a creative (draft)

Parameters

idstringpathrequired

Request body

application/json

headlinestringrequired

bodystring

imageUrlstring

= null

hrefstringrequired

ctastring

= Learn more

{
  "headline": "string",
  "body": "",
  "imageUrl": null,
  "href": "string",
  "cta": "Learn more"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/sponsors/bookings/{id}/creatives" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"headline":"string","body":"","imageUrl":null,"href":"string","cta":"Learn more"}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "headline": "string",
  "body": "",
  "imageUrl": null,
  "href": "string",
  "cta": "Learn more",
  "id": "string",
  "bookingId": "string",
  "status": "draft",
  "reviewNote": "string",
  "decidedAt": "string"
}

Schema

headlinestringrequired

bodystringrequired

imageUrlstringrequired

= null

hrefstringrequired

ctastringrequired

= Learn more

idstringrequired

bookingIdstringrequired

statusstringrequired

draft | pending | approved | rejected

reviewNotestringrequired

decidedAtstringrequired

4XX Default Response

Same as 4XX · POST /v1/sponsors/bookings/{id}/move

5XX Default Response

Same as 4XX · POST /v1/sponsors/bookings/{id}/move

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

Edit a creative; it goes back to draft and needs approval again

Parameters

idstringpathrequired

Request body

application/json

headlinestring

bodystring

imageUrlstring

hrefstring

ctastring

{
  "headline": "string",
  "body": "string",
  "imageUrl": "string",
  "href": "string",
  "cta": "string"
}

Code samples

cURL

curl -X PATCH "https://hermeticor.com/v1/sponsors/creatives/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"headline":"string","body":"string","imageUrl":"string","href":"string","cta":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/sponsors/bookings/{id}/creatives

4XX Default Response

Same as 4XX · POST /v1/sponsors/bookings/{id}/move

5XX Default Response

Same as 4XX · POST /v1/sponsors/bookings/{id}/move

POSThttps://hermeticor.com/v1/sponsors/creatives/{id}/submit

Send a creative for approval

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/sponsors/bookings/{id}/creatives

4XX Default Response

Same as 4XX · POST /v1/sponsors/bookings/{id}/move

5XX Default Response

Same as 4XX · POST /v1/sponsors/bookings/{id}/move

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

Approve or reject a submitted creative

Parameters

idstringpathrequired

Request body

application/json

decisionstringrequired

approved | rejected

notestring

{
  "decision": "approved",
  "note": "string"
}

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/sponsors/bookings/{id}/creatives

4XX Default Response

Same as 4XX · POST /v1/sponsors/bookings/{id}/move

5XX Default Response

Same as 4XX · POST /v1/sponsors/bookings/{id}/move

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

Impressions, opens, clicks and CTR of a booking

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "booking": "string",
  "sponsor": "string",
  "publication": "string",
  "startsOn": "string",
  "endsOn": "string",
  "totals": {
    "impressions": 0,
    "opens": 0,
    "clicks": 0,
    "ctr": 0
  },
  "placements": [
    {
      "placementId": "string",
      "refKind": "campaign",
      "refId": "string",
      "slot": "string",
      "impressions": 0,
      "opens": 0,
      "clicks": 0,
      "ctr": 0
    }
  ]
}

Schema

bookingstringrequired

sponsorstringrequired

publicationstringrequired

startsOnstringrequired

endsOnstringrequired

totalsobjectrequired

Show child parameters

impressionsnumberrequired

opensnumberrequired

clicksnumberrequired

ctrnumberrequired

placementsPlacementsItem[]required

Show child parameters

placementIdstringrequired

refKindstringrequired

campaign | post

refIdstringrequired

slotstringrequired

impressionsnumberrequired

opensnumberrequired

clicksnumberrequired

ctrnumberrequired

4XX Default Response

Same as 4XX · POST /v1/sponsors/bookings/{id}/move

5XX Default Response

Same as 4XX · POST /v1/sponsors/bookings/{id}/move

POSThttps://hermeticor.com/v1/sponsors/bookings/{id}/report-link

Create a new shareable report link for the sponsor (revokes the previous one)

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "url": "string"
}

Schema

urlstringrequired

4XX Default Response

Same as 4XX · POST /v1/sponsors/bookings/{id}/move

5XX Default Response

Same as 4XX · POST /v1/sponsors/bookings/{id}/move

Next part

Updated Nov 8, 2026

Was this page helpful?