Update profile
const url = 'https://api.wink.travel/api/managing-entity/e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18/extranet/property/profile';const options = { method: 'PATCH', headers: { 'If-Match': '', 'Wink-Version': '2.0', Authorization: 'Bearer <token>', 'Content-Type': 'application/json' }, body: 'null'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PATCH \ --url https://api.wink.travel/api/managing-entity/e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18/extranet/property/profile \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --header 'If-Match: ' \ --header 'Wink-Version: 2.0' \ --data nullApplies changes to the property’s core profile information (such as name and descriptive text) and returns the updated property. Send the property’s current version as If-Match for optimistic concurrency (409 on conflict).
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Update basic information for this property identifier
Example
e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18Header Parameters
Section titled “Header Parameters”The property’s last-seen version, for optimistic concurrency. Optional; a stale value is rejected with 409. Accepts a bare version (3), a quoted entity-tag (“3”), W/“3”, or *.
Request Bodyrequired
Section titled “Request Bodyrequired”Core property profile fields to update, such as name, star rating, property type, and contact details
Request body for creating or replacing a property’s profile metadata, including star rating, category codes, chain, brand, year built, and room count.
object
Hotel brand name if property is part of that brand.
Example
Happy ResortsHotel chain name if property is part of that chain.
Example
Getaway ResortsBusiness license or hotel operating permit number for the property.
Example
HT-2024-00123Number of rooms / keys for property
Example
40Hotel star rating.
Example
4Property’s brand.com website.
Example
https://www.hotel-x.comYear the property was constructed.
Example
1927Example
{ "architecturalStyle": "7", "hotelBrand": "Happy Resorts", "hotelCategory": "45", "hotelChain": "Getaway Resorts", "licenseNumber": "HT-2024-00123", "locationCategory": "34", "numberOfRooms": 40, "segmentCategory": "7", "stars": 4, "website": "https://www.hotel-x.com", "whenBuilt": "1927"}Responses
Section titled “Responses”Updated property record reflecting the new profile information
Lightweight projection of a property (hotel), used by consumers outside the property module.
object
Property address.
object
Address line 1
Address line 2
City name
Country
Country
County
Address 1, Address 2, City, State, Postal / Zip code, Country
Postal / zip code
State
Supported OTA specification ARC code.
City location
object
Ascii name of city
Country
object
Country capital
Continent code
Currency code
Currency name
Country GeoNames identifier
ISO code
Country name
ISO 3166-1 alpha-2 country code for the country this location belongs to
GeoNames specific feature code identifying the place type (e.g. PPL=populated place, PPLC=national capital, ISL=island)
GeoName identifier
Coordinate points of the city
object
Name of city
Country sub division
object
Sub-country ascii name
Sub-country GeoNames identifier
Sub-country name
Country sub sub division
object
ASCII-transliterated name of the county or district, safe for URLs and sorting
GeoNames.org unique identifier for this subdivision
Official name of the county or district in its local script
IANA timezone identifier for the location
GeoNameLightweight type
Url name
Datetime this record was first created
Currency code
Localized short and long welcome text of property.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Whether it was user or system generated.
Longer text description
Indicate which language this description is written in.
The md5 hash of the name, description and language.
Use as title or short text description
General manager related data.
object
Localized welcome message from GM.
Simplified localized description containing text content and its language code.
object
Whether it was user or system generated.
Longer text description
Indicate which language this description is written in.
The md5 hash of the name, description and language.
Profile image of the general manager.
object
Media angle
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Whether it was user or system generated.
Longer text description
Indicate which language this description is written in.
The md5 hash of the name, description and language.
Use as title or short text description
Media height in pixels.
Use this identifier to communicate with Cloudinary.
True if media width is greater or equal to height
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Document identifier
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Media width in pixels.
Name of GM currently managing the property.
Google Maps URL of the place
Properties that answered the Green Index questionnaire [full or partial], will have aggregate scores available.
object
Total score divided by high score
The highest possible score from all questions
A single scored answer to a Green Index sustainability question for a property.
object
Unique key identifying the Green Index question that was answered.
Score awarded for this answer (contributes toward the category high score).
Aggregate scores by Green Index category
Aggregated Green Index score for a single question category, showing how many sustainability points a property earned versus the maximum possible for that category.
object
Total score divided by high score within this category
Green Index category
The highest possible score from all questions within this category
The total score from all questions answered within this category
The total score from all questions answered
Supported OTA specification HAC code.
Hotel brand name if property is part of that brand.
Supported OTA specification PCT code.
Hotel chain name if property is part of that chain.
A shorter unique code to refer to the hotel. Country Code + 5 digit number
Unique identifier for this record.
Datetime this record was last updated
Legal name of your hotel as it is registered.
Business license or hotel operating permit number for the property.
Whether property has any lifestyles associated with her profile.
Name of the hotel in its local language if you use it for domestic guests.
Supported OTA specification LOC code.
GeoJSON point containing latitude and longitude of property. Note: x = longitude, y = latitude.
object
If another company entity is managing this property, on behalf of the property, it can be specified here and the managing entity would be applicable a management fee on every booking.
object
Agency commission
Entity identifier
Name of entity
Optional rules for expiration date etc when agency is no longer managing this entity.
object
Optional expiration date when agency is no longer managing this entity.
Whether managing entity rules has expired.
Optional total number of bookings [left] the agency is entitled to commission. This number will decrement every time a booking is made with this agency involved.
Whether managing entity is eligible a commission.
Let users manage this entity and all sub-entities.
object
Email address of the managing entity team member.
First name of the team member.
Last name of the team member.
Account owner
Phone number for contacting the team member.
Profile picture is available
object
Media angle
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Whether it was user or system generated.
Longer text description
Indicate which language this description is written in.
The md5 hash of the name, description and language.
Use as title or short text description
Media height in pixels.
Use this identifier to communicate with Cloudinary.
True if media width is greater or equal to height
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Document identifier
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Media width in pixels.
Secondary/alternative email address for the team member.
Per-section access grants for object-level ACL
object
Access level (READ < WRITE < FULL); a higher level subsumes all lower ones
Functional area of the platform this grant applies to; ALL is a wildcard that covers every section
Invitation status: PENDING (invite sent, awaiting response), ACCEPTED (active team member).
Unique identifier of the associated user (null until invitation is accepted).
Managing entity identifier. In a 1-1 relationship, this is typically the same as the user identifier.
Marketing contact information
object
Contact E-mail
Contact first name
First and last name
Contact last name
Contact phone number
Contact secondary Email
Summary
Place to put stuff into
object
List of images / videos of property.
Multimedia that contains less information than Multimedia object
object
Media angle
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Whether it was user or system generated.
Longer text description
Indicate which language this description is written in.
The md5 hash of the name, description and language.
Use as title or short text description
Media height in pixels.
Use this identifier to communicate with Cloudinary.
True if media width is greater or equal to height
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Document identifier
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Media width in pixels.
Unique hotel trade name.
Number of rooms / keys for property
If the property is currently using a channel manager but it isn’t yet part of our list, the name of that channel manager.
Application owner identifier that created this record.
Type of entity this is.
Optional Google Place ID for properties with a Google Business account.
Platform approved property.
Property policies such as pets and children, early and late checkout and more
object
When the guest can check in.
When the guest has to check out.
Indicates whether property allows children
When a property allows children, it can also indicate what the minimum age is for children to be allowed.
Indicates the availability of internet on the property.
Indicates where internet is available in and around the property.
Indicates how guests can access the Internet on the property.
Indicates what type of parking is available at the property.
Indicates whether parking is available at the property.
If pets are allowed, property can tell travelers if there is a charge applicable for the pet.
object
Monetary amount value
ISO 4217 currency code
If pets are allowed, property can further limit on weight.
Indicates whether pets are allowed on the property. Note: There are thousand different kinds of pets. Just because the property allows small dogs does not mean the guest can bring a python. Always best to check with property.
Supported OTA specification PHY code.
Supported OTA specification SEC code.
This can be an enum for external channel managers or an identifier for a Wink company rate provider
object
English readable text of the value.
The value that should be persisted.
Inventory-level recognition.
Recognition for the ancillary blocking.
object
Recognition category.
The date the award was received
Recognition identifier.
Use this to let hotels indicate what the total score for this award is.
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.
The name of the entity that administers this recognition.
The actual award or rating received by the hotel facility.
Provides the symbol used in the rating. Used in conjunction with the Rating.
Type of rating system the recognition operated on. This allows us to display the score properly.
If the reservation desk does not operate 24 hours, enter an end time.
If the reservation desk does not operate 24 hours, enter a start time.
Reservation desk contact information
object
Contact E-mail
Contact first name
First and last name
Contact last name
Contact phone number
Contact secondary Email
Summary
Accounting contact information
object
Contact E-mail
Contact first name
First and last name
Contact last name
Contact phone number
Contact secondary Email
Summary
Supported OTA specification SEG code.
Whether property has any social networks associated with her profile.
List of all social network account property has.
Social network
object
URL or social network identifier to social network profile
Type of social network.
Hotel star rating.
Wink.travel sets this status as the hotel moves through the payment workflow and manually for approval.
Type of sales channel
Event shorter name
Unique url-friendly slug to identify property
User owner identifier.
Optimistic-locking version. Echo this value back as an If-Match request header on a conditional update; the server responds 409 if the record changed in the meantime. Null when this projection has no backing versioned document, in which case no conditional update is possible.
Property brand.com website.
Year the property was constructed.
Example
{ "currencyCode": "THB", "hotelCode": "TH00042", "id": "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "managingEntityIdentifier": "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "name": "The Siam Residences", "numberOfRooms": 40, "ownerIdentifier": "9c2e7f1a-4b8d-4e3c-a5f6-2d9b1e0c7a43", "ownerType": "INDIVIDUAL", "stars": 5, "status": "ACTIVE", "type": "COMPANY", "urlName": "the-siam-residences-bangkok", "userIdentifier": "c3a9f2e1-8b4d-4c7a-a1e2-5f0b6d9e2c84"}Bad Request — missing or invalid request parameter or body
object
object
Example
Unauthorized — authentication is required or the session has expired
object
object
Example
Forbidden — authenticated but lacking the required permission or scope
object
object
Example
Not Found — the requested resource does not exist
object
object
Example
Method Not Allowed — the HTTP verb is not supported on this endpoint
object
object
Example
Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version
object
object
Example
Unsupported Media Type — use application/json
object
object
Example
Internal Server Error — an unexpected failure occurred on the server
object
object
Example
Service Unavailable — a downstream dependency is unreachable