Skip to content

Update User Profile

PUT
/api/profile
curl --request PUT \
--url https://api.wink.travel/api/profile \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Wink-Version: 2.0' \
--data '{ "share": false, "user": "", "personal": "", "preferences": "" }'

Updates the authenticated user’s profile with the provided information. Persists personal details, preferences, and sharing settings. Returns the updated profile asynchronously.

Wink-Version
string
default: 2.0.0
Allowed values: 2.0

User profile data to update

Media type application/json
object
share
required

Whether the user wants to share this profile with hotels

boolean
Example
true
user
required

User details

object
firstName

User first name

string
""
Example
Alexandra
lastName

User last name

string
""
Example
Beaumont
email

User email address

string format: email
""
phone

User phone number

string
""
Example
+66212658866
profilePictureUrl

Profile picture URL

string
""
Example
https://res.cloudinary.com/wink/image/upload/v1/user/alexandra-beaumont.jpg
fullName

Full name

string
""
Example
John Smith
personal
required

Detailed customer information for this profile

object
gender

Identifies the gender of the customer.

string
""
Allowed values: MALE FEMALE OTHER
Example
FEMALE
birthDate

Date of birth in ISO 8601 format

string format: date
""
Example
1985-06-15
maritalStatus

Marital status of the traveler

string
""
Allowed values: ANNULLED COHABITATING DIVORCED ENGAGED MARRIED SEPARATED SINGLE WIDOWED UNKNOWN
Example
MARRIED
childQuantity

Number of children

integer format: int32
""
Example
2
citizenship

Country of citizenship

string
""
Example
Thailand
address1

Primary address line

string
""
Example
123 Petchburi Road
address2

Secondary address line

string
""
Example
Ratchathewi District
city

City name

string
""
Example
Bangkok
state

State or province

string
""
Example
Bangkok
postalCode

Postal code

string
""
Example
10400
country

Country code (ISO 3166-1 alpha-2)

string
""
Example
TH
preferredCurrency

Preferred currency for monetary values (ISO 4217 code)

string
""
Example
USD
language

Primary language (ISO 639-1 code)

string
""
Example
en
contactPerson
Array<object>

Array of emergency contact information for the customer

object
firstName

Contact first name

string
""
Example
John
lastName

Contact last name

string
""
Example
Smith
email

Contact E-mail

string format: email
""
secondaryEmail

Contact secondary Email

string
""
phoneNumber

Contact phone number

string
""
Example
+12125551212
fullName

First and last name

string
""
Example
John Smith
summary

Summary

string
""
Example
John Smith ([email protected] / +12125551212)
physChallName
Array<string>
petInfo
Array<object>

Array of customer’s pets

object
name
required

Pet name

string
"" >= 1 characters
Example
Luna
type
required

Pet type

string
"" >= 1 characters
Example
Golden Retriever
preferences
required

Customer preferences

object
propertyLocationPref

Preferred hotel property locations

string
""
Example
Beachfront
propertyTypePref

Preferred hotel property types

string
""
Example
Luxury Resort
hotelChainPref

Preferred hotel chain name

string
""
Example
Mandarin Oriental
propertyAmenityPref

Preferred hotel property amenities

Array<string>
recreationSrvcPref

Preferred recreation services

Array<string>
businessSrvcPref

Preferred business services

Array<string>
securityFeaturePref

Preferred security features

Array<string>
physChalFeaturePref

Preferred accessibility features

Array<string>
""
Example
Wheelchair accessible rooms
smokingAllowed

Preference for smoking allowed rooms

boolean
Example
false
roomLocationPref

Preferred hotel room locations

string
""
Example
High floor with city view
bedTypePref

Preferred hotel bed type

string
""
Example
King bed
foodSrvcPref

Preferred food service facilities

string
""
Example
In-room dining
roomAmenityPref

Preferred hotel room amenities

Array<string>
guestType

Guest type classification

string
""
Example
Business traveler
mealPref

Meal preference

string
""
Example
Continental breakfast
cuisinePref

Cuisine preference

string
""
Example
Thai
interestPref

Interest preferences

Array<string>
beveragePref

Beverage preferences

Array<string>
foodPref

Food preferences

Array<string>
allergies

Known allergies

Array<string>
petsPref

Pet-friendly preferences

Array<string>

Profile updated successfully

Media type application/json
object
id

Document UUID

string format: uuid
""
createdDate

Datetime this record was first created

string format: date-time
""
lastUpdate

Datetime this record was last updated

string format: date-time
""
version

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.

integer format: int64
""
userIdentifier
required

User identifier

string format: uuid
"" >= 1 characters
share
required

Indicates whether the user wants to share this profile of themselves with hotel(s)

boolean
user
required

User details

object
firstName

User first name

string
""
lastName

User last name

string
""
email

User email address

string format: email
""
phone

User phone number

string
""
profilePictureUrl

Profile picture URL

string
""
fullName

Full name

string
""
personal
required

Detailed customer information for this profile

object
gender

Identifies the gender of the customer.

string
""
Allowed values: MALE FEMALE OTHER
birthDate

Date of birth in ISO 8601 format

string format: date
""
maritalStatus

Marital status of the traveler

string
""
Allowed values: ANNULLED COHABITATING DIVORCED ENGAGED MARRIED SEPARATED SINGLE WIDOWED UNKNOWN
childQuantity

Number of children

integer format: int32
""
citizenship

Country of citizenship

string
""
address1

Primary address line

string
""
address2

Secondary address line

string
""
city

City name

string
""
state

State or province

string
""
postalCode

Postal code

string
""
country

Country code (ISO 3166-1 alpha-2)

string
""
preferredCurrency

Preferred currency for monetary values (ISO 4217 code)

string
""
language

Primary language (ISO 639-1 code)

string
""
contactPerson
Array<object>

Array of emergency contact information for the customer

object
firstName

Contact first name

string
""
lastName

Contact last name

string
""
email

Contact E-mail

string format: email
""
secondaryEmail

Contact secondary Email

string
""
phoneNumber

Contact phone number

string
""
fullName

First and last name

string
""
summary

Summary

string
""
physChallName
Array<string>
petInfo
Array<object>

Array of customer’s pets

object
name
required

Pet name

string
"" >= 1 characters
type
required

Pet type

string
"" >= 1 characters
preferences
required

Customer preferences

object
propertyLocationPref

Preferred hotel property locations

string
""
propertyTypePref

Preferred hotel property types

string
""
hotelChainPref

Preferred hotel chain name

string
""
propertyAmenityPref

Preferred hotel property amenities

Array<string>
recreationSrvcPref

Preferred recreation services

Array<string>
businessSrvcPref

Preferred business services

Array<string>
securityFeaturePref

Preferred security features

Array<string>
physChalFeaturePref

Preferred accessibility features

Array<string>
""
smokingAllowed

Preference for smoking allowed rooms

boolean
roomLocationPref

Preferred hotel room locations

string
""
bedTypePref

Preferred hotel bed type

string
""
foodSrvcPref

Preferred food service facilities

string
""
roomAmenityPref

Preferred hotel room amenities

Array<string>
guestType

Guest type classification

string
""
mealPref

Meal preference

string
""
cuisinePref

Cuisine preference

string
""
interestPref

Interest preferences

Array<string>
beveragePref

Beverage preferences

Array<string>
foodPref

Food preferences

Array<string>
allergies

Known allergies

Array<string>
petsPref

Pet-friendly preferences

Array<string>
key
additional properties
""
Example

Invalid request body or validation error

object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
Example generated
{
"type": "https://example.com",
"title": "example",
"status": 1,
"detail": "example",
"instance": "https://example.com",
"properties": {
"additionalProperty": "example"
}
}

User not authenticated

Media type */*
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties

Forbidden

Media type */*
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties

Internal Server Error

object
Example generated
{}