Update Guest Room
const url = 'https://api.wink.travel/api/managing-entity/hotel-1/extranet/facility/room-type/guest-room-1';const options = { method: 'PUT', headers: {'Wink-Version': '2.0', 'Content-Type': 'application/json'}, body: '{"featuredInd":false,"lifestyleType":"LIFESTYLE_HEALTH_FITNESS","location":"","descriptions":[""],"multimedias":[null],"address":null,"commissionable":true,"name":"","proximityCode":"","sort":"","minAgeAppropriateCode":"","bookable":true,"active":true,"disabilityFeatures":[""],"securityFeatures":[""],"contact":"","socials":[null],"pricePoint":"HALF","recognitionList":[null],"transactionalInventoryList":[""],"maxOccupancy":2,"minOccupancy":1,"quantity":"","nonSmoking":false,"bedroomConfigurationList":[""],"size":"","maxAdultOccupancy":2,"maxChildOccupancy":0,"bathroomCount":1,"livingRoomCount":1,"maxRollaways":0,"roomCategory":"","floor":"","roomLocationCode":"","roomViewCode":"","composite":false,"compositeCount":0,"roomClassificationCode":"","roomArchitectureCode":"","roomGender":"Male","sharedRoomInd":false,"maxCribs":0,"amenities":[""],"includedAdultOccupancy":2,"includedChildOccupancy":0,"baseRate":"","minRate":""}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PUT \ --url https://api.wink.travel/api/managing-entity/hotel-1/extranet/facility/room-type/guest-room-1 \ --header 'Content-Type: application/json' \ --header 'Wink-Version: 2.0' \ --data '{ "featuredInd": false, "lifestyleType": "LIFESTYLE_HEALTH_FITNESS", "location": "", "descriptions": [ "" ], "multimedias": [ null ], "address": null, "commissionable": true, "name": "", "proximityCode": "", "sort": "", "minAgeAppropriateCode": "", "bookable": true, "active": true, "disabilityFeatures": [ "" ], "securityFeatures": [ "" ], "contact": "", "socials": [ null ], "pricePoint": "HALF", "recognitionList": [ null ], "transactionalInventoryList": [ "" ], "maxOccupancy": 2, "minOccupancy": 1, "quantity": "", "nonSmoking": false, "bedroomConfigurationList": [ "" ], "size": "", "maxAdultOccupancy": 2, "maxChildOccupancy": 0, "bathroomCount": 1, "livingRoomCount": 1, "maxRollaways": 0, "roomCategory": "", "floor": "", "roomLocationCode": "", "roomViewCode": "", "composite": false, "compositeCount": 0, "roomClassificationCode": "", "roomArchitectureCode": "", "roomGender": "Male", "sharedRoomInd": false, "maxCribs": 0, "amenities": [ "" ], "includedAdultOccupancy": 2, "includedChildOccupancy": 0, "baseRate": "", "minRate": "" }'Update a room by its identifier
Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”Update room type owned by this property identifier
Example
hotel-1Update room type with this identifier
Example
guest-room-1Header Parameters
Section titled “Header Parameters ”Request Body required
Section titled “Request Body required ”object
Indicates whether this inventory is featured. Use this flag as a way to signify that this inventory is special.
Example
falseIndicate the type of lifestyle this blocking should be associated with.
Example
LIFESTYLE_HEALTH_FITNESSGeo-location point where blocking takes place. Defaults to location of property.
object
Example
{ "type": "POINT", "coordinates": [ 100.5581533, 13.7370197 ]}Localized descriptions describing inventory.
object
Use as title or short text description
Example
An example titleLonger text description
Example
This is a longer description in the specified language.Indicate which language this description is written in.
Example
enList of images / videos of blocking.
Multimedia that contains less information than Multimedia object
object
Document identifier
Example
image-1Use this identifier to communicate with Cloudinary.
Example
cloudinary-image-1Whether Cloudinary media is a VIDEO or IMAGE.
Example
IMAGECurrently ONLY using Cloudinary to store all image / video assets.
Example
CLOUDINARYSort allows you to control how you want to sort this record in a list of media records.
Example
10Media angle
Example
-90Media width in pixels.
Example
2560Media height in pixels.
Example
1600Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Example
trueLocalized media captions to give user some context about where this media was taken.
object
Use as title or short text description
Example
An example titleLonger text description
Example
This is a longer description in the specified language.Indicate which language this description is written in.
Example
enWhether it was user or system generated.
Example
SYSTEMThe md5 hash of the name, description and language.
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Example
LIFESTYLE_HEALTH_FITNESSWhether image has attribution properties
object
URL to contributor
Example
https://maps.google.com/maps/contrib/111628493169070103594Name of contributor
Example
Samuel AdamsTrue if media width is greater or equal to height
Example
trueDefaults to property address.
object
Address line 1
Example
234 Near da beachAddress line 2
Example
Pebble #5001State
Example
CAPostal / zip code
Example
90210County
Example
Alameda countyCity name
Country
Country
Example
United StatesAddress 1, Address 2, City, State, Postal / Zip code, Country
Example
11 At home, Suite 3C, New York City, NY 10010, United StatesIndicate whether sales channels receive commission for selling this blocking.
Example
trueInternal name of blocking.
Example
Archery lessonUse this property to sort an blocking in a list of activities.
Example
1Indicates if this blocking can be added to a booking or if it is read-only marketing material only.
Example
trueModify blocking availability with this flag.
Example
trueSupported OTA specification PHY code. See OTA geoname data
Supported OTA specification SEC code. See OTA geoname data
Associate a contact person for this blocking (if applicable).
object
Contact first name
Example
JohnContact last name
Example
SmithContact phone number
Example
+12125551212First and last name
Example
John SmithSocial network accounts for blocking (if applicable).
Social network
object
Type of social network.
URL or social network identifier to social network profile
Level of expensiveness.
Example
THREEInventory-level recognition.
Recognition for the ancillary blocking.
object
Recognition identifier.
Example
recognition-1Recognition category.
Example
AWARDType of rating system the recognition operated on. This allows us to display the score properly.
Example
PERCENT_RATINGThe name of the entity that administers this recognition.
Example
MichelinThe actual award or rating received by the hotel facility.
Example
8.5Use this to let hotels indicate what the total score for this award is.
Example
10The date the award was received
Example
2020-10-24When true, this indicates the property has received official permission from the award provider to use the rating in publications and marketing materials; when false this permission has not been granted.
Example
trueProvides the symbol used in the rating. Used in conjunction with the Rating.
Example
*Purchasable items for this blocking.
This is one bookable item that can stand alongside a restaurant / meeting room etc.
object
Unique transactional identifier
Example
travel-blocking-1Internal name of transactional blocking.
Example
1 hour sessionLocalized descriptions describing inventory.
object
Use as title or short text description
Example
An example titleLonger text description
Example
This is a longer description in the specified language.Indicate which language this description is written in.
Example
enWhether it was user or system generated.
Example
SYSTEMThe md5 hash of the name, description and language.
How this blocking item should be priced.
Base price of booking this blocking.
object
If you are selling this blocking at a discount, indicate the discounted selling price. Leave empty if there is no discount.
object
List of images / videos of item.
Multimedia that contains less information than Multimedia object
object
Document identifier
Example
image-1Use this identifier to communicate with Cloudinary.
Example
cloudinary-image-1Whether Cloudinary media is a VIDEO or IMAGE.
Example
IMAGECurrently ONLY using Cloudinary to store all image / video assets.
Example
CLOUDINARYSort allows you to control how you want to sort this record in a list of media records.
Example
10Media angle
Example
-90Media width in pixels.
Example
2560Media height in pixels.
Example
1600Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Example
trueLocalized media captions to give user some context about where this media was taken.
object
Use as title or short text description
Example
An example titleLonger text description
Example
This is a longer description in the specified language.Indicate which language this description is written in.
Example
enWhether it was user or system generated.
Example
SYSTEMThe md5 hash of the name, description and language.
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Example
LIFESTYLE_HEALTH_FITNESSWhether image has attribution properties
object
URL to contributor
Example
https://maps.google.com/maps/contrib/111628493169070103594Name of contributor
Example
Samuel AdamsTrue if media width is greater or equal to height
Example
trueWhether there is a limit to minimum group size.
Example
2Whether there is a limit to maximum group size.
Example
10Calculates the percent difference between basePrice and discountedPrice.
Example
0.1Calculates the percent difference between basePrice and discountedPrice.
Example
0.1Maximum number of guest allowed in a room type.
Example
2Minimum number of guests allowed in a room type.
Example
1Defines the number of rooms of this type
Example
40Non-smoking indicator
Example
trueA room type can have more than one bed configuration.
object
Unique identifier
Name of layout
A room type can have more than one bedroom configuration.
object
Type of bedroom
A bedroom can have more than one bed type.
object
Indicates the type of bed(s) found in the room. Typical values would be Double, Twin, Queen, or King. Supported OTA specification BED code. See OTA geoname data.
Example
1Number of beds for this bed type.
Example
10Number of square meters that defines the size of this room type.
Example
55Maximum number of adults allowed in a room type.
Example
1Maximum number of children allowed in a room type.
Example
0Number of bathrooms
Example
0Number of living rooms
Example
0Maximum number of rollaway beds allowed in this room type.
Example
0Indicates the category of the room. Typical values would be Moderate, Standard, or Deluxe. Supported OTA specification SEG code. See OTA geoname data
Example
1Floor an which a room is located
Indicates the location of the room within the hotel structure. Typical values would be “Near Exit”,“Close to elevator”, “Low Floor” or “High Floor”. Supported OTA specification RLT code. See OTA geoname data
Example
1Indicates the view of the room. Typical values would be “Ocean view”, “Pool view” or “Garden View”. Supported OTA specification RVT code. See OTA geoname data
Example
1Indicates that the room (suite) is a composite of smaller units.
Example
falseNumber of rooms of this room type that makes up a larger unit (composite) such as a two bedroom suite could be comprised of two king rooms plus other room types. A 0 means disabled.
Example
2Specifies the room classification (e.g., cabin, apartment). Supported OTA specification GRI code. See OTA geoname data
Example
1Specifies the architectural style of a room. Supported OTA specification ARC code. See OTA geoname data
Example
1Used to request or specify a gender assignment for a room. Note: Typically used by Hosteliers.
Example
FemaleIf TRUE, the room requires or has sharing available. Note: Typically used by Hosteliers.
Example
falseMaximum number of cribs allowed in a room type.
Example
1Collection of room amenity items available to the guest. Supported OTA specification RMA code. See OTA geoname data
The number of pax the room price was meant for
Example
2The number of children the room price was meant for
Example
0Typical one night rate during regular remand period
object
Typical one night rate in a distressed period
object
Responses
Section titled “ Responses ”OK
object
Document UUID
Datetime this record was first created
Datetime this record was last updated
Version property that shows how many times this document has been persisted. Document will not persist if the version property is less than current version property in the system. Result in an optimistic locking exception.
Hotel identifier.
Indicates whether this inventory is featured. Use this flag as a way to signify that this inventory is special.
Indicate the type of lifestyle this blocking should be associated with.
Geo-location point where blocking takes place. Defaults to location of property.
object
Localized descriptions describing inventory.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
List of images / videos of blocking.
Multimedia that contains less information than Multimedia object
object
Document identifier
Use this identifier to communicate with Cloudinary.
Whether Cloudinary media is a VIDEO or IMAGE.
Currently ONLY using Cloudinary to store all image / video assets.
Sort allows you to control how you want to sort this record in a list of media records.
Media angle
Media width in pixels.
Media height in pixels.
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Whether image has attribution properties
object
URL to contributor
Name of contributor
True if media width is greater or equal to height
Associate a contact person for this blocking (if applicable).
object
Contact first name
Contact last name
Contact E-mail
Contact secondary Email
Contact phone number
First and last name
Summary
Defaults to property address.
object
Address line 1
Address line 2
State
Postal / zip code
County
City name
Country
Country
Address 1, Address 2, City, State, Postal / Zip code, Country
Indicate whether sales channels receive commission for selling this blocking.
Internal name of blocking.
Supported OTA specification PRX code. See OTA geoname data
Use this property to sort an blocking in a list of activities.
Supported OTA specification AQC code. See OTA geoname data
Indicates if this blocking can be added to a booking or if it is read-only marketing material only.
Modify blocking availability with this flag.
Supported OTA specification PHY code. See OTA geoname data
Supported OTA specification SEC code. See OTA geoname data
Social network accounts for blocking (if applicable).
Social network
object
Type of social network.
URL or social network identifier to social network profile
Level of expensiveness.
Inventory-level recognition.
Recognition for the ancillary blocking.
object
Recognition identifier.
Recognition category.
Type of rating system the recognition operated on. This allows us to display the score properly.
The name of the entity that administers this recognition.
The actual award or rating received by the hotel facility.
Use this to let hotels indicate what the total score for this award is.
The date the award was received
When true, this indicates the property has received official permission from the award provider to use the rating in publications and marketing materials; when false this permission has not been granted.
Provides the symbol used in the rating. Used in conjunction with the Rating.
Purchasable items for this blocking.
This is one bookable item that can stand alongside a restaurant / meeting room etc.
object
Unique transactional identifier
Internal name of transactional blocking.
Localized descriptions describing inventory.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
How this blocking item should be priced.
Base price of booking this blocking.
object
If you are selling this blocking at a discount, indicate the discounted selling price. Leave empty if there is no discount.
object
List of images / videos of item.
Multimedia that contains less information than Multimedia object
object
Document identifier
Use this identifier to communicate with Cloudinary.
Whether Cloudinary media is a VIDEO or IMAGE.
Currently ONLY using Cloudinary to store all image / video assets.
Sort allows you to control how you want to sort this record in a list of media records.
Media angle
Media width in pixels.
Media height in pixels.
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Whether image has attribution properties
object
URL to contributor
Name of contributor
True if media width is greater or equal to height
Whether there is a limit to minimum group size.
Whether there is a limit to maximum group size.
Calculates the percent difference between basePrice and discountedPrice.
Calculates the percent difference between basePrice and discountedPrice.
Maximum number of guest allowed in a room type.
Minimum number of guests allowed in a room type.
Defines the number of rooms of this type
Non-smoking indicator
A room type can have more than one bed configuration.
object
Unique identifier
Name of layout
A room type can have more than one bedroom configuration.
object
Type of bedroom
A bedroom can have more than one bed type.
object
Indicates the type of bed(s) found in the room. Typical values would be Double, Twin, Queen, or King. Supported OTA specification BED code. See OTA geoname data.
Number of beds for this bed type.
Number of square meters that defines the size of this room type.
Maximum number of adults allowed in a room type.
Maximum number of children allowed in a room type.
Number of bathrooms
Number of living rooms
Maximum number of rollaway beds allowed in this room type.
Indicates the category of the room. Typical values would be Moderate, Standard, or Deluxe. Supported OTA specification SEG code. See OTA geoname data
Floor an which a room is located
Indicates the location of the room within the hotel structure. Typical values would be “Near Exit”,“Close to elevator”, “Low Floor” or “High Floor”. Supported OTA specification RLT code. See OTA geoname data
Indicates the view of the room. Typical values would be “Ocean view”, “Pool view” or “Garden View”. Supported OTA specification RVT code. See OTA geoname data
Indicates that the room (suite) is a composite of smaller units.
Number of rooms of this room type that makes up a larger unit (composite) such as a two bedroom suite could be comprised of two king rooms plus other room types. A 0 means disabled.
Specifies the room classification (e.g., cabin, apartment). Supported OTA specification GRI code. See OTA geoname data
Specifies the architectural style of a room. Supported OTA specification ARC code. See OTA geoname data
Used to request or specify a gender assignment for a room. Note: Typically used by Hosteliers.
If TRUE, the room requires or has sharing available. Note: Typically used by Hosteliers.
Maximum number of cribs allowed in a room type.
Collection of room amenity items available to the guest. Supported OTA specification RMA code. See OTA geoname data
The number of pax the room price was meant for
The number of children the room price was meant for
Typical one night rate during regular remand period
object
Typical one night rate in a distressed period
object
Example
nullBad Request
object
object
Example generated
{ "type": "https://example.com", "title": "example", "status": 1, "detail": "example", "instance": "https://example.com", "properties": { "additionalProperty": "example" }}object
object
object
object
object
object
object
object
Unauthorized
object
object
Forbidden
object
object
Internal Server Error
object
Example generated
{}