--- title: "PATCH amenity" method: PATCH path: "/v3/amenities/{id}" tags: ["Amenities"] --- # PATCH amenity `PATCH /v3/amenities/{id}` ## Request - Base URL: `https://api.bookingexperts.com` - URL: `https://api.bookingexperts.com/v3/amenities/{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) Updates the amenity for the given ID ## Path parameters - `id` string, required ## Query parameters - `fields[amenity]` string - `include` string ## Headers - `Accept-Language` string ## Request body - object - `data` object: Amenities are for external and internal use. They can be used to signify amenities of a RentableType or Rentable that are important to the guest. For example: * With sauna * Free wi-fi An Amenity can optionally be numerical or multiple choice. When an Amenity is numerical, the values of linked amenities (RentableTypeAmenity, RentableAmenity, ReservationAmenity and RoomAmenity) denote the numerical value belonging to the amenity. When an Amenity is multiple choice, the values of linked amenities denote the ID of the AmenityOption that applies. - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `filterable` boolean: Administration has configured the amenity to appear as a filter - `highlightable` boolean: Administration has configured the amenity to appear as a highlight - `relationships` object: Relationships - `amenity_group` object: Group that the amenity belongs to - `data` object - `id` string: amenity_group 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. - `amenity_options` object - `data` object[] - `id` string: amenity_options 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 - AmenityGroup: Provides a way for Organizations to categorize Amenities. - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `name` object: Name of the amenity - `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 - `position` integer - `applies_to_administration` boolean: Administration amenity groups can be used to show amenities on the administration level, for example 'close to sea' or 'with playground' - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. - AmenityOption: Represents an option of an Amenity with type Amenities::MultipleChoiceAmenity. - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `name` object: Name of the amenity option - `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 - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. ## Response `200` AmenityResponse - object - `data` Amenity: Amenities are for external and internal use. They can be used to signify amenities of a RentableType or Rentable that are important to the guest. For example: * With sauna * Free wi-fi An Amenity can optionally be numerical or multiple choice. When an Amenity is numerical, the values of linked amenities (RentableTypeAmenity, RentableAmenity, ReservationAmenity and RoomAmenity) denote the numerical value belonging to the amenity. When an Amenity is multiple choice, the values of linked amenities denote the ID of the AmenityOption that applies. - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `name` object: Name of the amenity - `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 - `description` object: Description to display along with the highlightable amenity - `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 - `icon_url` string: URL of icon to display along with highlightable amenity - `type` 'Amenity' | 'Amenities::NumericalAmenity' | 'Amenities::MultipleChoiceAmenity': Type of the amenity - `position` integer - `semantic_amenity_type` 'accessible_toilet' | 'accessible_washbasin' | 'afternoon_sun' | 'air_hockey' | 'airco' | 'amazon_prime' | 'animation' | 'baby_bath' | 'baby_monitor' | 'balcony' | 'bathtub' | 'bbq' | 'beach_front' | 'beach_view' | 'bed_linen_provided' | 'bedroom_tv' | 'bicycle' | 'bicycle_rental' | 'bicycle_storage' | 'bidet' | 'billiard_table' | 'bluray_player' | 'boat' | 'bocce_ball' | 'bowling_alley' | 'box_bed' | 'boxspring' | 'breakfast_service' | 'bunk_bed' | 'cabinet_locks' | 'cable_tv' | 'cai_hookup' | 'canoe' | 'car_free' | 'carbon_monoxide_detector' | 'cd_player' | 'ceiling_fan' | 'central_heating' | 'central_location' | 'ceramic_cooktop' | 'child_friendly' | 'childproof_electrical_outlets' | 'close_to_beach' | 'coffee_brewing_system' | 'coffee_capsule_system' | 'coffee_pad_system' | 'combi_microwave' | 'combi_oven' | 'communal_pool' | 'computer_monitor' | 'conservatory' | 'cookware' | 'corner_site' | 'cot' | 'cradle' | 'crib' | 'cutlery' | 'dartboard' | 'deck' | 'decorative_fireplace' | 'desk' | 'desk_chair' | 'dining_table' | 'disco' | 'dishes' | 'dishwasher' | 'disinfected' | 'disney_plus' | 'double_bed' | 'double_washbasin' | 'downtown' | 'drinking_glasses' | 'dryer' | 'drying_rack' | 'dvd_player' | 'ebike_charging_point' | 'electric_cooktop' | 'electricity_hookup' | 'elevator' | 'enhanced_cleaning' | 'ev_charging_point' | 'evening_sun' | 'extractor_hood' | 'fenced_pool' | 'fenced_yard' | 'final_cleaning' | 'fire_extinguisher' | 'fire_pit' | 'fireplace' | 'first_aid_kit' | 'fitness_room' | 'flatscreen_tv' | 'floor' | 'football_pitch' | 'forest' | 'forest_front' | 'forest_view' | 'free_standing' | 'free_wifi' | 'freezer' | 'gaming_console' | 'garden' | 'garden_furniture' | 'gas_cooktop' | 'gas_heater' | 'golf_course_front' | 'golf_course_view' | 'golfcourt' | 'grill' | 'guest_gap_period_24_hours' | 'guest_gap_period_48_hours' | 'guest_gap_period_72_hours' | 'hair_dryer' | 'hammock' | 'hangers' | 'hbo' | 'heated_pool' | 'heater' | 'high_chair' | 'high_touch_surfaces_disinfected' | 'horseriding' | 'hot_tub' | 'indoor_playground' | 'indoor_pool' | 'induction_cooktop' | 'insect_screens' | 'internet' | 'iron' | 'ironing_board' | 'jacuzzi' | 'kettle' | 'kingsize_bed' | 'kitchen' | 'kitchen_island' | 'kitchen_utensils' | 'kitchenette' | 'lake_front' | 'lake_view' | 'linens_high_temp_wash' | 'lounge_set' | 'loungers' | 'marina' | 'microwave' | 'minibar' | 'minigolf' | 'morning_sun' | 'motion_detector' | 'mountain_view' | 'mountains' | 'netflix' | 'ocean_front' | 'ocean_view' | 'office' | 'other' | 'outdoor_kitchen' | 'outdoor_playground' | 'outdoor_pool' | 'outdoor_shower' | 'oven' | 'paid_wifi' | 'parasol' | 'parking_area' | 'party_games' | 'patio' | 'paved_surface' | 'pedal_gokarts' | 'pellet_stove' | 'pet_friendly' | 'petting_zoo' | 'playground_front' | 'playground_view' | 'playpen' | 'pool_front' | 'pool_table' | 'printer' | 'private_garage' | 'private_golf' | 'private_parking' | 'private_pool' | 'private_sanitary' | 'private_tennis' | 'quay' | 'queensize_bed' | 'quiet_location' | 'radio' | 'refrigerator' | 'resort' | 'restaurant' | 'river' | 'rowboat' | 'rural' | 'safe' | 'sanitary_front' | 'satellite_tv' | 'sauna' | 'self_service_check_in' | 'semi_double_bed' | 'sewer_hookup' | 'shadow' | 'shower' | 'shower_chair' | 'single_bed' | 'single_floor' | 'smart_tv' | 'smoke_detector' | 'smoke_free' | 'smoking_allowed' | 'sofa_bed' | 'sound_system' | 'stair_gate' | 'storage_room' | 'streaming_service' | 'sunshower' | 'swing' | 'table_football_table' | 'table_tennis_table' | 'tanning_bed' | 'telephone' | 'tenniscourt' | 'toaster' | 'toilet' | 'towels' | 'toys' | 'trampoline' | 'twin_beds' | 'underfloor_heating' | 'vacuum_cleaner' | 'veranda' | 'videoland' | 'village' | 'volleyball_court' | 'wardrobe' | 'washbasin' | 'washer' | 'water_front' | 'water_hookup' | 'water_view' | 'wellness' | 'wheelchair_accessible' | 'wifi' | 'wood_stove' - `filterable` boolean: Administration has configured the amenity to appear as a filter - `highlightable` boolean: Administration has configured the amenity to appear as a highlight - `relationships` object: Relationships - `amenity_group` object: Group that the amenity belongs to - `data` object - `id` string: amenity_group 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. - `amenity_options` object - `data` object[] - `id` string: amenity_options 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 - AmenityGroup: Provides a way for Organizations to categorize Amenities. - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `name` object: Name of the amenity - `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 - `position` integer - `applies_to_administration` boolean: Administration amenity groups can be used to show amenities on the administration level, for example 'close to sea' or 'with playground' - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. - AmenityOption: Represents an option of an Amenity with type Amenities::MultipleChoiceAmenity. - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `name` object: Name of the amenity option - `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 - `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`: 1 info - endpoint added [Operation history](https://skmtc.dev/bookingexperts/apis/booking-experts-api-v3/changes/v3/amenities/: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)