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 Body required
Section titled “Request Body required ”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
Document identifier
Example
3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51Use 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.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
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.
Example
d41d8cd98f00b204e9800998ecf8427eExample
{ "name": "Deluxe River View Suite", "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", "creator": "USER", "md5ContentHash": "a3f1c8e2d74b60912a5c3e9b1d7f4e82"}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 AdamsExample
{ "url": "https://maps.google.com/maps/contrib/111628493169070103594", "name": "Samuel Adams"}True if media width is greater or equal to height
Example
trueExample
{ "multimediaIdentifier": "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "identifier": "the-siam-residences/lobby-entrance", "type": "IMAGE", "source": "CLOUDINARY", "sort": 10, "angle": null, "width": 2560, "height": 1600, "published": true, "category": "2", "descriptions": [ { "title": "Lobby Entrance", "description": "Elegant lobby of The Siam Residences", "language": "en" } ], "lifestyleType": null, "attribution": [], "isLandscape": true}Example
{ "firstName": "Alexandra", "lastName": "Beaumont", "profilePicture": { "multimediaIdentifier": "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "identifier": "the-siam-residences/lobby-entrance", "type": "IMAGE", "source": "CLOUDINARY", "sort": 10, "angle": null, "width": 2560, "height": 1600, "published": true, "category": "2", "descriptions": [ { "title": "Lobby Entrance", "description": "Elegant lobby of The Siam Residences", "language": "en" } ], "lifestyleType": null, "attribution": [], "isLandscape": true }}Responses
Section titled “ Responses ”Updated user profile after applying the requested changes
User profile response including identifier, name, email, and optional profile picture
object
Unique user identifier (UUID)
User first name
User last name
Email address used as login username
Profile picture metadata from Cloudinary or federated identity provider
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.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
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
Fully qualified Cloudinary URL for the user’s profile picture
Example
{ "identifier": "c3a9f2e1-8b4d-4c7a-a1e2-5f0b6d9e2c84", "firstName": "Alexandra", "lastName": "Beaumont", "profilePicture": { "multimediaIdentifier": "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "identifier": "the-siam-residences/lobby-entrance", "type": "IMAGE", "source": "CLOUDINARY", "sort": 10, "angle": null, "width": 2560, "height": 1600, "published": true, "category": "2", "descriptions": [ { "title": "Lobby Entrance", "description": "Elegant lobby of The Siam Residences", "language": "en" } ], "lifestyleType": null, "attribution": [], "isLandscape": true }, "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
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