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

Parameters

limitintegerquery

= 50

cursorstringquery

statusstringquery

scheduled | live | completed | cancelled

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/marketing-events" \
  -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"
    }
  ],
  "nextCursor": "string"
}

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

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/marketing-events

POSThttps://hermeticor.com/v1/marketing-events

Request body

application/json

namestringrequired

kindstring

webinar | event | conference | workshop = webinar

startsAtstring

endsAtstring

urlstring

organizerstring

capacityinteger

statusstring

scheduled | live | completed | cancelled = scheduled

externalRefstring

{
  "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"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/marketing-events" \
  -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","externalRef":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 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

5XX Default Response

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

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

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/marketing-events

4XX Default Response

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

5XX Default Response

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

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

Parameters

idstringpathrequired

Code samples

cURL

curl -X DELETE "https://hermeticor.com/v1/marketing-events/{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

5XX Default Response

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

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

Parameters

idstringpathrequired

Request body

application/json

namestring

kindstring

webinar | event | conference | workshop

startsAtstring

endsAtstring

urlstring

organizerstring

capacityinteger

statusstring

scheduled | live | completed | cancelled

externalRefstring

{
  "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"
}

Code samples

cURL

curl -X PATCH "https://hermeticor.com/v1/marketing-events/{id}" \
  -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","externalRef":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/marketing-events

4XX Default Response

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

5XX Default Response

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

GEThttps://hermeticor.com/v1/marketing-events/{id}/registrations

Parameters

limitintegerquery

= 50

cursorstringquery

statusstringquery

registered | attended | no_show | cancelled

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "eventId": "string",
      "email": "string",
      "profileId": "string",
      "status": "registered",
      "attendedAt": "2024-01-01T00:00:00Z",
      "durationSec": 0,
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

idstringrequired

eventIdstringrequired

emailstringrequired

profileIdstringrequired

statusstringrequired

registered | attended | no_show | cancelled

attendedAtstringrequired

durationSecintegerrequired

createdAtstringrequired

nextCursorstringrequired

4XX Default Response

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

5XX Default Response

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

POSThttps://hermeticor.com/v1/marketing-events/{id}/registrations

Register people; each registration is written to the timeline as event_registered (it is not marketing consent)

Parameters

idstringpathrequired

Request body

application/json

emailsstring[]required

{
  "emails": [
    "string"
  ]
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/marketing-events/{id}/registrations" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"emails":["string"]}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "registered": 0,
  "skipped": [
    {
      "email": "string",
      "reason": "string"
    }
  ]
}

Schema

registeredintegerrequired

skippedobject[]required

Show child parameters

emailstringrequired

reasonstringrequired

4XX Default Response

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

5XX Default Response

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

POSThttps://hermeticor.com/v1/marketing-events/{id}/registrations/cancel

Parameters

idstringpathrequired

Request body

application/json

emailstringrequired

{
  "email": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/marketing-events/{id}/registrations/cancel" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"email":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

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

4XX Default Response

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

5XX Default Response

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

POSThttps://hermeticor.com/v1/marketing-events/{id}/attendance

Import attendance; writes event_attended (and optionally event_no_show) to the timeline for segments and workflows

Parameters

idstringpathrequired

Request body

application/json

rowsobject[]required

Show child parameters

emailstringrequired

durationSecinteger

markNoShowsboolean

= false

{
  "rows": [
    {
      "email": "string",
      "durationSec": 0
    }
  ],
  "markNoShows": false
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/marketing-events/{id}/attendance" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"rows":[{"email":"string","durationSec":0}],"markNoShows":false}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "attended": 0,
  "noShows": 0
}

Schema

attendedintegerrequired

noShowsintegerrequired

4XX Default Response

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

5XX Default Response

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

Next part

Updated Nov 8, 2026

Was this page helpful?