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>

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

Parameters

refstringpathrequired

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/marketing-events/by-ref/{ref}/complete" \
  -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

Example

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

Schema

errorobjectrequired

Show child parameters

codestringrequired

messagestringrequired

detailsobject

5XX Default Response

Same as 4XX · POST /v1/marketing-events/by-ref/{ref}/complete

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

Registrations of the event grouped by state

Parameters

refstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "eventId": "string",
  "externalRef": "string",
  "byState": {}
}

Schema

eventIdstringrequired

externalRefstringrequired

byStateobjectrequired

4XX Default Response

Same as 4XX · POST /v1/marketing-events/by-ref/{ref}/complete

5XX Default Response

Same as 4XX · POST /v1/marketing-events/by-ref/{ref}/complete

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

Registrations of the event grouped by state

Parameters

idstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/marketing-events/{id}/participations" \
  -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}/participations

4XX Default Response

Same as 4XX · POST /v1/marketing-events/by-ref/{ref}/complete

5XX Default Response

Same as 4XX · POST /v1/marketing-events/by-ref/{ref}/complete

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

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/marketing-events/{id}/lists" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "listId": "string",
      "name": "string"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem162[]required

Show child parameters

listIdstringrequired

namestringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · POST /v1/marketing-events/by-ref/{ref}/complete

5XX Default Response

Same as 4XX · POST /v1/marketing-events/by-ref/{ref}/complete

PUThttps://hermeticor.com/v1/marketing-events/{id}/lists/{listId}

Attach a list and register its members

Parameters

idstringpathrequired

listIdstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "listId": "string",
  "registered": 0,
  "skipped": 0
}

Schema

listIdstringrequired

registeredintegerrequired

skippedintegerrequired

4XX Default Response

Same as 4XX · POST /v1/marketing-events/by-ref/{ref}/complete

5XX Default Response

Same as 4XX · POST /v1/marketing-events/by-ref/{ref}/complete

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

Detach a list (people already registered stay registered)

Parameters

idstringpathrequired

listIdstringpathrequired

Code samples

cURL

curl -X DELETE "https://hermeticor.com/v1/marketing-events/{id}/lists/{listId}" \
  -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 · POST /v1/marketing-events/by-ref/{ref}/complete

5XX Default Response

Same as 4XX · POST /v1/marketing-events/by-ref/{ref}/complete

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

Parameters

limitintegerquery

Page size; omitted returns the whole list

cursorstringquery

Opaque: the nextCursor of the previous page

refstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

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

4XX Default Response

Same as 4XX · POST /v1/marketing-events/by-ref/{ref}/complete

5XX Default Response

Same as 4XX · POST /v1/marketing-events/by-ref/{ref}/complete

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

Parameters

refstringpathrequired

listIdstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · PUT /v1/marketing-events/{id}/lists/{listId}

4XX Default Response

Same as 4XX · POST /v1/marketing-events/by-ref/{ref}/complete

5XX Default Response

Same as 4XX · POST /v1/marketing-events/by-ref/{ref}/complete

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

Parameters

refstringpathrequired

listIdstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

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

4XX Default Response

Same as 4XX · POST /v1/marketing-events/by-ref/{ref}/complete

5XX Default Response

Same as 4XX · POST /v1/marketing-events/by-ref/{ref}/complete

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

Change status, organizer or link on up to 100 events

Request body

application/json

idsstring[]required

patchobjectrequired

Show child parameters

statusstring

scheduled | live | completed | cancelled

organizerstring

urlstring

{
  "ids": [
    "string"
  ],
  "patch": {
    "status": "scheduled",
    "organizer": "string",
    "url": "string"
  }
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/marketing-events/batch/update" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"ids":["string"],"patch":{"status":"scheduled","organizer":"string","url":"string"}}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "done": 0,
  "missing": [
    "string"
  ]
}

Schema

doneintegerrequired

missingstring[]required

4XX Default Response

Same as 4XX · POST /v1/marketing-events/by-ref/{ref}/complete

5XX Default Response

Same as 4XX · POST /v1/marketing-events/by-ref/{ref}/complete

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

Delete up to 100 events with their registrations

Request body

application/json

idsstring[]required

{
  "ids": [
    "string"
  ]
}

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java