Update User Settings
const url = 'https://api.wink.travel/api/user-settings/profile';const options = { method: 'PATCH', headers: { '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/user-settings/profile \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --header 'Wink-Version: 2.0' \ --data nullUpdates the authenticated user’s profile with the supplied values and returns the saved profile.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Header Parameters
Section titled “Header Parameters”Request Bodyrequired
Section titled “Request Bodyrequired”Updated profile fields for the authenticated user including name, email address, and profile picture
User profile information including name, email, and profile picture
object
User first name
Example
AlexandraUser last name
Example
BeaumontProfile picture uploaded via Cloudinary; optional
object
Media angle
Example
-90Whether image has attribution properties
object
Name of contributor
Example
Samuel AdamsURL to contributor
Example
https://maps.google.com/maps/contrib/111628493169070103594Example
{ "name": "Samuel Adams", "url": "https://maps.google.com/maps/contrib/111628493169070103594"}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.
Example
SYSTEMLonger text description
Example
This is a longer description in the specified language.Indicate which language this description is written in.
Example
enThe md5 hash of the name, description and language.
Example
d41d8cd98f00b204e9800998ecf8427eUse as title or short text description
Example
An example titleExample
{ "creator": "USER", "description": "Spacious suite with floor-to-ceiling windows overlooking the Chao Phraya River, featuring a king-size bed, private balcony, and marble bathroom.", "language": "en", "md5ContentHash": "a3f1c8e2d74b60912a5c3e9b1d7f4e82", "name": "Deluxe River View Suite"}Media height in pixels.
Example
1600Use this identifier to communicate with Cloudinary.
Example
cloudinary-image-1True if media width is greater or equal to height
Example
trueAssociate 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_FITNESSDocument identifier
Example
3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Example
trueSort allows you to control how you want to sort this record in a list of media records.
Example
10Currently ONLY using Cloudinary to store all image / video assets.
Example
CLOUDINARYWhether Cloudinary media is a VIDEO or IMAGE.
Example
IMAGEMedia width in pixels.
Example
2560Example
{ "angle": null, "attribution": [], "category": "2", "descriptions": [ { "description": "Elegant lobby of The Siam Residences", "language": "en", "title": "Lobby Entrance" } ], "height": 1600, "identifier": "the-siam-residences/lobby-entrance", "isLandscape": true, "lifestyleType": null, "multimediaIdentifier": "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "published": true, "sort": 10, "source": "CLOUDINARY", "type": "IMAGE", "width": 2560}Example
{ "firstName": "Alexandra", "lastName": "Beaumont", "profilePicture": { "angle": null, "attribution": [], "category": "2", "descriptions": [ { "description": "Elegant lobby of The Siam Residences", "language": "en", "title": "Lobby Entrance" } ], "height": 1600, "identifier": "the-siam-residences/lobby-entrance", "isLandscape": true, "lifestyleType": null, "multimediaIdentifier": "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "published": true, "sort": 10, "source": "CLOUDINARY", "type": "IMAGE", "width": 2560 },}Responses
Section titled “Responses”Updated user profile after applying the requested changes
User profile response including identifier, name, email, and optional profile picture
object
User first name
Unique user identifier (UUID)
User last name
Profile picture metadata from Cloudinary or federated identity provider
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.
Fully qualified Cloudinary URL for the user’s profile picture
Email address used as login username
Example
{ "firstName": "Alexandra", "identifier": "c3a9f2e1-8b4d-4c7a-a1e2-5f0b6d9e2c84", "lastName": "Beaumont", "profilePicture": { "angle": null, "attribution": [], "category": "2", "descriptions": [ { "description": "Elegant lobby of The Siam Residences", "language": "en", "title": "Lobby Entrance" } ], "height": 1600, "identifier": "the-siam-residences/lobby-entrance", "isLandscape": true, "lifestyleType": null, "multimediaIdentifier": "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "published": true, "sort": 10, "source": "CLOUDINARY", "type": "IMAGE", "width": 2560 }, "profilePictureUrl": "https://res.cloudinary.com/wink/image/upload/v1/property/the-siam-residences.jpg",}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