events

Embed

<a href="https://hermeticor.com/docs/ref-events"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/ba4e2aac-0317-43ba-ae37-d77af083d547/social-card.svg?v=3e7ae33eec8b" alt="events" width="600" height="315"></a>

GEThttps://hermeticor.com/v1/marketing-events/search

Find events by external id or name

Parameters

refstringquery

namestringquery

limitintegerquery

= 25

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/marketing-events/search" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "name": "string",
      "kind": "webinar",
      "startsAt": "2024-01-01T00:00:00Z",
      "endsAt": "2024-01-01T00:00:00Z",
      "url": "string",
      "organizer": "string",
      "capacity": 0,
      "status": "scheduled",
      "externalRef": "string",
      "registered": 0,
      "attended": 0,
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ]
}

Schema

itemsItemsItem155[]required

Show child parameters

idstringrequired

namestringrequired

kindstringrequired

webinar | event | conference | workshop

startsAtstringrequired

endsAtstringrequired

urlstringrequired

organizerstringrequired

capacityintegerrequired

statusstringrequired

scheduled | live | completed | cancelled

externalRefstringrequired

registeredintegerrequired

= 0

attendedintegerrequired

= 0

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 · GET /v1/marketing-events/search

GEThttps://hermeticor.com/v1/marketing-events/apps

Event apps and their event-details URL templates

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "name": "string",
      "detailsUrlTemplate": "string",
      "id": "string",
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem161[]required

Show child parameters

namestringrequired

detailsUrlTemplatestringrequired

idstringrequired

createdAtstringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · GET /v1/marketing-events/search

5XX Default Response

Same as 4XX · GET /v1/marketing-events/search

PUThttps://hermeticor.com/v1/marketing-events/apps

Set the event-details URL template of an event app (by name)

Request body

application/json

namestringrequired

detailsUrlTemplatestringrequired

{
  "name": "string",
  "detailsUrlTemplate": "string"
}

Code samples

cURL

curl -X PUT "https://hermeticor.com/v1/marketing-events/apps" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","detailsUrlTemplate":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "name": "string",
  "detailsUrlTemplate": "string",
  "id": "string",
  "createdAt": "2024-01-01T00:00:00Z"
}

Schema

namestringrequired

detailsUrlTemplatestringrequired

idstringrequired

createdAtstringrequired

4XX Default Response

Same as 4XX · GET /v1/marketing-events/search

5XX Default Response

Same as 4XX · GET /v1/marketing-events/search

DELETEhttps://hermeticor.com/v1/marketing-events/apps/{id}

Parameters

idstringpathrequired

Code samples

cURL

curl -X DELETE "https://hermeticor.com/v1/marketing-events/apps/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "ok": true
}

Schema

okbooleanrequired

true

4XX Default Response

Same as 4XX · GET /v1/marketing-events/search

5XX Default Response

Same as 4XX · GET /v1/marketing-events/search

GEThttps://hermeticor.com/v1/marketing-events/participations/contact

Every event one address took part in, with its state

Parameters

emailstringqueryrequired

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/marketing-events/participations/contact?email=<email>" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "eventId": "string",
      "name": "string",
      "externalRef": "string",
      "status": "string"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

eventIdstringrequired

namestringrequired

externalRefstringrequired

statusstringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · GET /v1/marketing-events/search

5XX Default Response

Same as 4XX · GET /v1/marketing-events/search

GEThttps://hermeticor.com/v1/marketing-events/by-ref/{ref}

Parameters

refstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/marketing-events/by-ref/{ref}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "id": "string",
  "name": "string",
  "kind": "webinar",
  "startsAt": "2024-01-01T00:00:00Z",
  "endsAt": "2024-01-01T00:00:00Z",
  "url": "string",
  "organizer": "string",
  "capacity": 0,
  "status": "scheduled",
  "externalRef": "string",
  "registered": 0,
  "attended": 0,
  "createdAt": "2024-01-01T00:00:00Z"
}

Schema

idstringrequired

namestringrequired

kindstringrequired

webinar | event | conference | workshop

startsAtstringrequired

endsAtstringrequired

urlstringrequired

organizerstringrequired

capacityintegerrequired

statusstringrequired

scheduled | live | completed | cancelled

externalRefstringrequired

registeredintegerrequired

= 0

attendedintegerrequired

= 0

createdAtstringrequired

4XX Default Response

Same as 4XX · GET /v1/marketing-events/search

5XX Default Response

Same as 4XX · GET /v1/marketing-events/search

PUThttps://hermeticor.com/v1/marketing-events/by-ref/{ref}

Upsert an event by external id (creates when unknown)

Parameters

refstringpathrequired

Request body

application/json

namestringrequired

kindstring

webinar | event | conference | workshop = webinar

startsAtstring

endsAtstring

urlstring

organizerstring

capacityinteger

statusstring

scheduled | live | completed | cancelled = scheduled

{
  "name": "string",
  "kind": "webinar",
  "startsAt": "2024-01-01T00:00:00Z",
  "endsAt": "2024-01-01T00:00:00Z",
  "url": "string",
  "organizer": "string",
  "capacity": 0,
  "status": "scheduled"
}

Code samples

cURL

curl -X PUT "https://hermeticor.com/v1/marketing-events/by-ref/{ref}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","kind":"webinar","startsAt":"2024-01-01T00:00:00Z","endsAt":"2024-01-01T00:00:00Z","url":"string","organizer":"string","capacity":0,"status":"scheduled"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · GET /v1/marketing-events/by-ref/{ref}

4XX Default Response

Same as 4XX · GET /v1/marketing-events/search

5XX Default Response

Same as 4XX · GET /v1/marketing-events/search

DELETEhttps://hermeticor.com/v1/marketing-events/by-ref/{ref}

Parameters

refstringpathrequired

Code samples

cURL

curl -X DELETE "https://hermeticor.com/v1/marketing-events/by-ref/{ref}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · DELETE /v1/marketing-events/apps/{id}

4XX Default Response

Same as 4XX · GET /v1/marketing-events/search

5XX Default Response

Same as 4XX · GET /v1/marketing-events/search

GEThttps://hermeticor.com/v1/marketing-events/by-ref/{ref}/identifiers

External id to Hermeticor id

Parameters

refstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/marketing-events/by-ref/{ref}/identifiers" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "id": "string",
  "externalRef": "string"
}

Schema

idstringrequired

externalRefstringrequired

4XX Default Response

Same as 4XX · GET /v1/marketing-events/search

5XX Default Response

Same as 4XX · GET /v1/marketing-events/search

POSThttps://hermeticor.com/v1/marketing-events/by-ref/{ref}/cancel

Parameters

refstringpathrequired

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/marketing-events/by-ref/{ref}/cancel" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · GET /v1/marketing-events/by-ref/{ref}

4XX Default Response

Same as 4XX · GET /v1/marketing-events/search

5XX Default Response

Same as 4XX · GET /v1/marketing-events/search

Next part

Updated Nov 8, 2026

Was this page helpful?