BizKitHub
DocsAPI ReferenceCalendar/api/v1/calendar/add-event
postCalendarPublic API v1

/api/v1/calendar/add-event

No description provided.

calendarpostApiV1CalendarAdd-event

Parameters

1 query · JSON body

Query parameters

· 1
apiKeystringRequired

Your BizKitHub API key (passed as GET parameter).

Key format: A 32-character string matching: ^(PROD|DEV_|ROOT)[A-Za-z0-9]{28}$
Prefixes: PROD (production key), DEV_ (individual developer), ROOT (system key with no limits). Learn more

ExamplePRODPGrFxpGEtrOZfuWhnoJohUYBXuOE

Request body

application/json
eventobjectRequired
calendarIdstringRequired

Unique identifier of the calendar where the event will be created.

Example2WRp6X5rSqQa321EjHB2mxZz74u74H84
startTimestringRequireddate-time

ISO 8601 timestamp marking when the event starts.

Example2024-05-01T10:00:00.000Z
endTimestringRequireddate-time

ISO 8601 timestamp marking when the event ends.

Example2024-05-01T12:00:00.000Z
titlestringRequired

Short title that clearly describes the event.

Length: 1–250
ExampleTraining with Jan
descriptionstringOptional

Additional details that describe the event context or purpose.

ExampleTraining will start in Prague – Nusle.
agendastringOptional

List of agenda items or talking points. Other team members may edit this content.

Example– Warm-up – Deadlift technique – Cool down
urlstringOptional

Public or internal link associated with the event.

Examplehttps://gymroom.cz/pobocky/vinohrady
notifyBeforestringOptional

Relative time before the event when email/sms notification should be sent.

Example1h 30m
blockingTostringOptionaldate-time

Time until which the calendar slot remains blocked. Prevents overlapping reservations in the same resource.

Example2024-05-01T12:00:00.000Z
locationTitlestringOptional

Full physical address of the event location.

ExampleVaršavská 11, 120 00, Praha 2 – Vinohrady
isAllDaybooleanOptional

If true, the event spans the entire day (00:00–23:59).

Default: false
Examplefalse
isBlockingbooleanOptional

If true, the event occupies a time slot and conflicts with other events.

Default: true
Exampletrue
attendeesobject[]Optional
Each array item:
memberIdnumberOptional

Internal system identifier of a registered member.

Example1234
customerIdnumberOptional

Unique external customer identifier,

ExampleHxanU4a1n4El61zx
namestringRequired

Full name of the attendee.

ExampleJan Barášek
emailstringOptional

Email address of the attendee.

phonestringOptional

Phone number of the attendee in international format.

Example+420 777123456
typestringOptional

Classification of the event, used for filtering and analytics. Unknown type will be created.

Examplestrainingwebinar

Response schema

1 status code documented

200Success
eventIdstringRequired
Examplefqdjnvzrfqjcsmvyhgjirjtvftknayzx

Response example

application/json
{
  "eventId": "fqdjnvzrfqjcsmvyhgjirjtvftknayzx"
}

Request example

POST /api/v1/calendar/add-event

post
curl -X POST "https://api.bizkithub.com/api/v1/calendar/add-event?apiKey=PRODPGrFxpGEtrOZfuWhnoJohUYBXuOE" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "event": {
    "calendarId": "2WRp6X5rSqQa321EjHB2mxZz74u74H84",
    "startTime": "2024-05-01T10:00:00.000Z",
    "endTime": "2024-05-01T12:00:00.000Z",
    "title": "Training with Jan",
    "description": "Training will start in Prague – Nusle.",
    "agenda": "– Warm-up\n– Deadlift technique\n– Cool down",
    "url": "https://gymroom.cz/pobocky/vinohrady",
    "notifyBefore": "1h 30m",
    "blockingTo": "2024-05-01T12:00:00.000Z",
    "locationTitle": "Varšavská 11, 120 00, Praha 2 – Vinohrady",
    "isAllDay": false,
    "isBlocking": true,
    "attendees": [
      {
        "memberId": 1234,
        "customerId": "HxanU4a1n4El61zx",
        "name": "Jan Barášek",
        "email": "[email protected]",
        "phone": "+420 777123456"
      }
    ],
    "type": "training"
  }
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key