BizKitHub
DocsAPI ReferenceCalendar/bff/calendar/calendar-settings-update
postCalendarAdmin BFF

/bff/calendar/calendar-settings-update

Partially updates calendar settings. Only provided fields are changed. Requires the authenticated member to have permission on the calendar.

CalendarpostBffCalendarCalendar-settings-update

Parameters

JSON body

Request body

application/json
codestringRequired

External calendar code identifier.

namestringOptional

Calendar display name.

colorstringOptional

Calendar hex color (e.g., "#FF5733").

timezonestringOptional

Calendar timezone (e.g., "Europe/Prague").

publicDescriptionstring | nullOptional
One of 2:
Variant 1
string

Public description shown to customers.

Variant 2
null
internalDescriptionstring | nullOptional
One of 2:
Variant 1
string

Internal note (not shown to customers).

Variant 2
null
emailDescriptionstring | nullOptional
One of 2:
Variant 1
string

Description included in email notifications.

Variant 2
null
emailDescriptionTranslationsobjectOptional

Per-locale e-mail description keyed by locale code (e.g. {"en": "…", "uk": "…"}). {{ calendarEmailDescription }} returns the text in the recipient's locale; an empty value falls back to emailDescription. Only the listed locales change; each must be enabled for the organisation.

defaultLocationTitlestring | nullOptional
One of 2:
Variant 1
string

Default location title for new events.

Variant 2
null
productIdnumber | nullOptional
One of 2:
Variant 1
number

Linked product ID.

Variant 2
null
variantIdnumber | nullOptional
One of 2:
Variant 1
number

Linked product variant ID.

Variant 2
null
lockIdnumber | nullOptional
One of 2:
Variant 1
number

External TTLock identifier of the smart lock to bind to this calendar (matches iot__ttlock_lock.lock_id and the /iot-lock/[lockId] admin route). null unlinks the current lock. The lock must belong to the same organisation.

Variant 2
null
settingsPublicDescriptionstring | nullOptional
One of 2:
Variant 1
string

Public description in settings context.

Variant 2
null
settingsInternalDescriptionstring | nullOptional
One of 2:
Variant 1
string

Internal description in settings context.

Variant 2
null
onlineChangeDeadlinestringOptional

Deadline for online changes (ISO duration or similar).

reserveFromstringOptional

Earliest time customers can reserve.

reserveUntilstringOptional

Latest time customers can reserve.

timeSlotIntervalstringOptional

Time slot interval for the booking grid.

lateCancelEnabledbooleanOptional

Allow late cancellation without refund between onlineChangeDeadline and lateCancelMinBefore before the start.

lateCancelMinBeforestringOptional

Latest point before the start when a late cancellation is still allowed (relative time, e.g. "2h").

accessCodeNotifyBeforestring | nullOptional
One of 2:
Variant 1
string

How long before the start the reservation reminder (access-code e-mail) is sent, e.g. "10m". Overrides the notifyBefore sent by the website; null = use the website value.

Variant 2
null

Response schema

1 status code documented

200Success

This response returns no JSON body.

Response example

application/json
{
  "success": true
}

Request example

POST /bff/calendar/calendar-settings-update

post
curl -X POST "https://api.bizkithub.com/bff/calendar/calendar-settings-update" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "code": "example_code",
  "name": "example_name",
  "color": "example_color",
  "timezone": "example_timezone",
  "emailDescriptionTranslations": {},
  "onlineChangeDeadline": "example_onlineChangeDeadline",
  "reserveFrom": "example_reserveFrom",
  "reserveUntil": "example_reserveUntil",
  "timeSlotInterval": "example_timeSlotInterval",
  "lateCancelEnabled": false,
  "lateCancelMinBefore": "example_lateCancelMinBefore"
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key