--- title: "PATCH external_blocked_agenda_period" method: PATCH path: "/v3/administrations/{administration_id}/external_blocked_agenda_periods/{id}" tags: ["AgendaPeriods"] --- # PATCH external_blocked_agenda_period `PATCH /v3/administrations/{administration_id}/external_blocked_agenda_periods/{id}` ## Request - Base URL: `https://api.bookingexperts.com` - URL: `https://api.bookingexperts.com/v3/administrations/{administration_id}/external_blocked_agenda_periods/{id}` - Auth: one of: - API key in header `X-API-KEY` - OAuth 2 - Authorization code: `/oauth/authorize` - Token URL: `/oauth/token` - TypeScript: (a function with typed inputs; its response is checked against the schema) Update an external blocked agenda period. ## Path parameters - `administration_id` string, required - `id` string, required ## Query parameters - `fields[agenda_period]` string - `include` string ## Headers - `Accept-Language` string ## Request body - object - `data` object: A blocking event on the calendar of a Rentable. This includes Reservations and maintenance events. - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `label` string: The label shown on the calendar. For maintenance periods with a custom block type, this is the name of the block type. Setting the comment through label is deprecated, use memo instead. - `memo` string: The comment of the agenda period. When both label and memo are passed, memo is used. - `start_date` string, date - `end_date` string, date - `relationships` object: Relationships - `rentable` object - `data` object - `id` string: rentable ID - `type` string - `meta` object - `temp_id` string: UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known. - `method` string: Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update. - `inventory_object` object - `data` object - `id` string: inventory_object ID - `type` string - `meta` object - `temp_id` string: UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known. - `method` string: Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update. - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. - `included` union[] - union - Rentable: A rentable is a period during which a InventoryObject can be rented. A InventoryObject can have multiple rentables, each representing different configurations (type, tags, pet policy, for rent, etc...) of the same physical accommodation. This exists because it's typical for holiday parks to upgrade accommodations. When changing validity of rentables, note that other rentables might become inactive due to this change. A InventoryObject cannot have more than one active Rentable for a given date. - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `active_from` string, date - `active_till` string, date - `pets_allowed` boolean - `for_rental` boolean: DEPRECATED: all rentables are for rental - `name` string - `map_identifier` string: Returns the identifier of this Rentable in the interactive Administration map - `unbooked_date_ranges` array[]: Yields unbooked date ranges for this rentable - string[] - `geo_json` object: Yields the GeoJSON Feature for the Rentable in the interactive Administration map (if set) - `created_at` string, date-time - `updated_at` string, date-time - `relationships` object: Relationships - `category` object: DEPRECATED use rentable_type instead - `data` object - … - `rentable_type` object - `data` object - … - `rentable_identity` object: DEPRECATED use inventory_object instead - `data` object - … - `inventory_object` object - `data` object - … - `rentable_amenities` object - `data` object[] - … - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. - InventoryObject: An accommodation that can be booked as part of a Reservation - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `name` string - `original_identifier` string: The identifier of this object in a previous system - `door_name` string - `energy_label` 'exempt' | 'A++++' | 'A+++' | 'A++' | 'A+' | 'A' | 'B' | 'C' | 'D' | 'E' | 'F' | 'G' | 'H': Energy label of building, may be any of the official energy labels or "exempt" if the accommodation is exempt from the energy label requirement.When blank, the current energy label of the acommmodation is unknown. - `surface_area` integer: The surface area in square meters - `lot_number` string: The lot number of the object - `blocked` boolean: Whether the inventory object is blocked or not from being booked - `custom_fields` object[]: Custom attributes assigned to this resource - `key` string - `text_value` string - `integer_value` integer - `attachment_text` object - `cs` string - `da-DK` string - `de` string - `de-AT` string - `de-CH` string - `en-US` string - `en-GB` string - `es` string - `fr` string - `fr-BE` string - `fr-LU` string - `it` string - `nb` string - `nl` string - `nl-BE` string - `pl` string - `pt` string - `tr` string - `en` string - `da` string - `name_with_type` string - `cluster_parent` boolean: If an object is a cluster parent, it represents a cluster of other (real) objects. - `archived` boolean - `created_at` string, date-time - `updated_at` string, date-time - `relationships` object: Relationships - `current_or_future_external_blocked_agenda_periods` object: Relationship for sideposting external blocked agenda periods. This relationship will never be returned in a response. - `data` object[] - … - `labels` object - `data` object[] - … - `administration` object - `data` object - … - `cluster_children` object: The objects that form this cluster object - `data` object[] - … - `images` object - `data` object[] - … - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. ## Response `200` AgendaPeriodResponse - object - `data` AgendaPeriod: A blocking event on the calendar of a Rentable. This includes Reservations and maintenance events. - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `label` string: The label shown on the calendar. For maintenance periods with a custom block type, this is the name of the block type. Setting the comment through label is deprecated, use memo instead. - `memo` string: The comment of the agenda period. When both label and memo are passed, memo is used. - `start_date` string, date - `end_date` string, date - `type` 'MaintenanceAgendaPeriod' | 'OwnerMaintenanceAgendaPeriod' | 'BlockedByGroupedRentableTypeAgendaPeriod' | 'ReservationAgendaPeriod' | 'ExternalBlockedAgendaPeriod' | 'NotEnoughStockAgendaPeriod' - `ical_uid` string - `created_at` string, date-time - `updated_at` string, date-time - `relationships` object: Relationships - `rentable` object - `data` object - `id` string: rentable ID - `type` string - `meta` object - `temp_id` string: UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known. - `method` string: Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update. - `inventory_object` object - `data` object - `id` string: inventory_object ID - `type` string - `meta` object - `temp_id` string: UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known. - `method` string: Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update. - `reservation` object - `data` object - `id` string: reservation ID - `type` string - `meta` object - `temp_id` string: UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known. - `method` string: Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update. - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. - `included` union[] - union - Rentable: A rentable is a period during which a InventoryObject can be rented. A InventoryObject can have multiple rentables, each representing different configurations (type, tags, pet policy, for rent, etc...) of the same physical accommodation. This exists because it's typical for holiday parks to upgrade accommodations. When changing validity of rentables, note that other rentables might become inactive due to this change. A InventoryObject cannot have more than one active Rentable for a given date. - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `active_from` string, date - `active_till` string, date - `pets_allowed` boolean - `for_rental` boolean: DEPRECATED: all rentables are for rental - `name` string - `map_identifier` string: Returns the identifier of this Rentable in the interactive Administration map - `unbooked_date_ranges` array[]: Yields unbooked date ranges for this rentable - string[] - `geo_json` object: Yields the GeoJSON Feature for the Rentable in the interactive Administration map (if set) - `created_at` string, date-time - `updated_at` string, date-time - `relationships` object: Relationships - `category` object: DEPRECATED use rentable_type instead - `data` object - … - `rentable_type` object - `data` object - … - `rentable_identity` object: DEPRECATED use inventory_object instead - `data` object - … - `inventory_object` object - `data` object - … - `rentable_amenities` object - `data` object[] - … - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. - InventoryObject: An accommodation that can be booked as part of a Reservation - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `name` string - `original_identifier` string: The identifier of this object in a previous system - `door_name` string - `energy_label` 'exempt' | 'A++++' | 'A+++' | 'A++' | 'A+' | 'A' | 'B' | 'C' | 'D' | 'E' | 'F' | 'G' | 'H': Energy label of building, may be any of the official energy labels or "exempt" if the accommodation is exempt from the energy label requirement.When blank, the current energy label of the acommmodation is unknown. - `surface_area` integer: The surface area in square meters - `lot_number` string: The lot number of the object - `blocked` boolean: Whether the inventory object is blocked or not from being booked - `custom_fields` object[]: Custom attributes assigned to this resource - `key` string - `text_value` string - `integer_value` integer - `attachment_text` object - `cs` string - `da-DK` string - `de` string - `de-AT` string - `de-CH` string - `en-US` string - `en-GB` string - `es` string - `fr` string - `fr-BE` string - `fr-LU` string - `it` string - `nb` string - `nl` string - `nl-BE` string - `pl` string - `pt` string - `tr` string - `en` string - `da` string - `name_with_type` string - `cluster_parent` boolean: If an object is a cluster parent, it represents a cluster of other (real) objects. - `archived` boolean - `created_at` string, date-time - `updated_at` string, date-time - `relationships` object: Relationships - `current_or_future_external_blocked_agenda_periods` object: Relationship for sideposting external blocked agenda periods. This relationship will never be returned in a response. - `data` object[] - … - `labels` object - `data` object[] - … - `administration` object - `data` object - … - `cluster_children` object: The objects that form this cluster object - `data` object[] - … - `images` object - `data` object[] - … - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. - Reservation: A reservation of a single accommodation (InventoryObject) as part of a Booking. Each Reservation in a Booking may have mutiple order items. The total price of a Booking is the sum of all order items belonging to its reservations. - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `start_date` string, date, required - `end_date` string, date, required - `late_checkout` boolean - `remote_reservation_key` string: Channel room booking ID - `guest_name` string: When having multiple reservations for an order, this can be used to store the guest name for this specific reservation. - `payment_guarantee` 'none' | 'cc/dc/voucher' | 'profile' | 'deposit' | 'pre_pay' | 'deposit_required': An optional payment guarantee - `note` string: An optional note or remark of the customer. - `promotion_token` string: Optional, can be used for passing the promotion token of the owner of the accommodation. This will check if the promotion token is correct for the given InventoryObject - `guest_group` object - `seniors` integer - `adults` integer - `adolescents` integer - `children` integer - `babies` integer - `pets` integer - `fixed_rentable` boolean: Whether or not reservation is made on a specific rentable, as opposed to a type. - `price_according_to_channel` object: Set the price according to the channel. Can only be specified on creation, a change request should be created otherwise. - `currency` string - `value` string - `price_according_to_channel_calculation` 'rent' | 'total' | 'total_excluding_hidden_costs' | 'total_including_all_costs_except_hidden_costs': How the price according to the channel should be interpreted, i.e., if it covers only the rent, or the total (the full all-in price). Can only be specified on creation, a change request should be created otherwise. - `checked_in_on` string, date-time: Timestamp that is set when the reservation is checked in. - `checked_out_on` string, date-time: Timestamp that is set when the reservation is checked out. - `is_cancelled_by_external_party` boolean: Whether the reservation has been cancelled by an external party - `cancellation_insurance` boolean: Whether this reservation has cancellation insurance - `license_plates` string[] - `cancel_date` string, date: Date on which the reservation has been cancelled - `cancel_reason` string: Reason why the reservation is cancelled - `requires_pet_free` boolean: Specifies if the reservation requires a pet free accommodation. true => no pets allowed, false => no preference - `custom_fields` object[]: Custom attributes assigned to this resource - `key` string - `text_value` string - `integer_value` integer - `option_validity` integer: DEPRECATED moved to Booking - `remote_booking_nr` string: DEPRECATED moved to Booking - `locale` 'cs' | 'da-DK' | 'de' | 'de-AT' | 'de-CH' | 'en-US' | 'en-GB' | 'es' | 'fr' | 'fr-BE' | 'fr-LU' | 'it' | 'nb' | 'nl' | 'nl-BE' | 'pl' | 'pt' | 'tr' | 'en' | 'da': DEPRECATED moved to Booking - `memo` string: DEPRECATED moved to Booking - `currency` 'EUR' | 'USD' | 'CHF' | 'CZK' | 'TRY' | 'CVE' | 'XCG' | 'GBP' | 'NOK' | 'DKK' | 'ZAR': DEPRECATED moved to Booking - `letter_in_booking` string: Yields the letter of the Reservation in the (multi) Booking - `created_at_date` string, date: Local date of creation of this reservation - `checkin_time` string: Guests should checkin from this time. - `checkout_time` string: Guests should checkout before this time. - `access_code` string: A generated numeric access code that is unique for all current and future reservations of the Administration. It is at least 4 characters long. - `stay_reason` 'tourism' | 'business': Reason of stay for the reservation - `blocking_todos_finished` boolean: Indicates if all blocking todos have been finished - `available_parking_spots` integer - `packaged_date_range` string[] - `late_checkout_possible` boolean: Whether or not it's possible for the customer to check out later than the normal checkout time. This depends on the next arrival. - `late_checkout_details` object - `description` object - … - `price` object - … - `original_total` object - `currency` string - `value` string - `total` object - `currency` string - `value` string - `total_without_vat` object - `currency` string - `value` string - `total_without_vat_without_deposit` object - `currency` string - `value` string - `deposit` object - `currency` string - `value` string - `rent_turnover` object - `currency` string - `value` string - `rent_turnover_without_vat` object - `currency` string - `value` string - `base_rent_including_discount` object: Base rent including the discount. This cannot be calculated for reservations with state `imported`, as they have no order. - `currency` string - `value` string - `provision` object - `currency` string - `value` string - `questions_completed` boolean: Marks if the customer answered the questions after reservation. These questsions can be configured. - `guest_list_completed` boolean: Marks if the guest list has been filled in. - `license_plates_completed` boolean: Marks if the guest provided license plates. Mostly used for access control. - `labels` string[]: User configurable labels. These labels are for internal use and thus never visible to the customer. - `created_at` string, date-time - `updated_at` string, date-time - `state` 'initial' | 'concept' | 'concept_to_be_accepted' | 'concept_option' | 'concept_to_be_accepted_option' | 'temporary' | 'temporary_to_be_accepted' | 'temporary_to_be_checked' | 'temporary_to_be_accepted_and_checked' | 'temporary_option' | 'temporary_to_be_accepted_option' | 'to_be_accepted' | 'to_be_accepted_option' | 'to_be_checked' | 'to_be_accepted_and_checked' | 'option' | 'rejected' | 'cancelling' | 'confirmed' | 'imported' | 'cancelled' - `deposit_completed` boolean - `booking_nr` string - `token` string - `confirmed_at` string, date-time - `owner_reservation` boolean - `paid_by_customer` boolean - `option_expires_at` string, date-time - `links` object: Links - `self` string: Link to self - `url` string: Link to url - `relationships` object: Relationships - `category` object: DEPRECATED use rentable_type instead - `data` object - … - `rentable_type` object - `data` object - … - `rentable_identity` object: DEPRECATED use inventory_object instead - `data` object - … - `inventory_object` object - `data` object - … - `booking` object: Returns the booking of the reservation. This relationship can be managed via sideposting. - `data` object - … - `links` object - … - `order` object: DEPRECATED use booking instead - `data` object - … - `links` object - … - `discount_card` object - `data` object - … - `primary_package` object - `data` object - … - `extra_packages` object - `data` object[] - … - `extra_order_items` object: Returns a list of all extras that were ordered. This relationship can also be used to manage the ordered extras via sideposting. - `data` object[] - … - `cancellation_rules` object: Returns a list of all cancellation rules. This relationship can also be used to manage the ordered extras via sideposting. - `data` object[] - … - `reservation_amenities` object - `data` object[] - … - `available_optional_amenities` object: Returns a list of the optional amenities of the rentables that are available for this reservation. - `data` object[] - … - `labels` object - `data` object[] - … - `administration` object - `data` object - … - `links` object - … - `discount_action` object - `data` object - … - `order_items` object: Returns a list of all order items. Costs and extras may possibly be grouped. This relationship should be used to render order details for the customer. - `data` object[] - … - `main_order_items` object: Returns a list of all main order items. No grouping is applied. Should not be used to render order details for the customer. - `data` object[] - … - `available_discount_cards` object - `data` object[] - … - `available_primary_packages` object - `data` object[] - … - `available_extra_packages` object - `data` object[] - … - `available_extras` object - `data` object[] - … - `question_answers` object - `data` object[] - … - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. ## Other responses - `429`: Error - `default`: Error ## Changes - **2026-11-03** `ff81bc4fefa9`: 3 warning, 12 info - added the new `da-DK` enum value to the `included/items/anyOf[#/components/schemas/Reservation]/attributes/locale` response property for the response status `200` - added the new `en-GB` enum value to the `included/items/anyOf[#/components/schemas/Reservation]/attributes/locale` response property for the response status `200` - added the new `en-US` enum value to the `included/items/anyOf[#/components/schemas/Reservation]/attributes/locale` response property for the response status `200` - added the new optional request property `data/attributes/memo` - …11 more [Operation history](https://skmtc.dev/bookingexperts/apis/booking-experts-api-v3/changes/v3/administrations/:administration_id/external_blocked_agenda_periods/:id/patch.md) --- [API](https://skmtc.dev/bookingexperts/apis/booking-experts-api-v3.md) - [All operations](https://skmtc.dev/bookingexperts/apis/booking-experts-api-v3/llms.txt) - [OpenAPI document](https://skmtc.dev/bookingexperts/apis/booking-experts-api-v3/revisions/ff81bc4fefa9?raw)