BizKitHub Developer Documentation

Parameters

JSON body

Request body

application/json

eventIdstringRequired

External event code identifier.

titlestringOptional

Event title.

descriptionstring | nullOptional

One of 2:

Variant 1

string

Event description (rich text). Set null to clear.

Variant 2

null

agendastring | nullOptional

One of 2:

Variant 1

string

Event agenda / schedule. Set null to clear.

Variant 2

null

urlstring | nullOptional

One of 2:

Variant 1

string

External URL associated with the event. Set null to clear.

Variant 2

null

startTimestringOptional

New start time (ISO 8601).

endTimestringOptional

New end time (ISO 8601).

isAllDaybooleanOptional

Whether the event spans the entire day.

isBlockingbooleanOptional

Whether the event blocks conflicting reservations in the same slot.

locationTitlestring | nullOptional

One of 2:

Variant 1

string

Location name / label. Set null to clear.

Variant 2

null

reservedBlockingTostring | nullOptional

One of 2:

Variant 1

string

Time until which the calendar slot is blocked (ISO 8601). Set null to clear.

Variant 2

null

typestring | nullOptional

One of 2:

Variant 1

string

Event type code (e.g., "workshop"). Set null to remove type assignment.

Variant 2

null

notifyBeforestring | nullOptional

One of 2:

Variant 1

string

Reminder relative time before event start (e.g., "30m", "1h", "1d"). Replaces existing reminder. Set null to remove all reminders.

Variant 2

null

visibility"organisation" | "shared" | "private" | nullOptional

One of 2:

Variant 1

"organisation" | "shared" | "private"

Per-event visibility override. NULL inherits from the calendar default. "private" hides the title and calendar from anyone but the owner — across all orgs.

Variant 2

null

Response schema

1 status code documented

200Success

successbooleanRequired

Whether the update was successful.

Response example

application/json

{
  "success": false
}

curl -X POST "https://api.bizkithub.com/bff/calendar/event-edit" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer YOUR_API_KEY" \ -d '{ "eventId": "example_eventId", "title": "example_title", "startTime": "example_startTime", "endTime": "example_endTime", "isAllDay": false, "isBlocking": false }'

/bff/calendar/event-edit

Parameters

Request body

Response schema

Response example

Request example

Need an API key?