Skip to content
Wink

Suggest profile

POST
/api/managing-entity/{managingEntityIdentifier}/extranet/property/profile/suggest
 
curl --request POST \
  --url https://api.wink.travel/api/managing-entity/e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18/extranet/property/profile/suggest \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Wink-Version: 2.0' \
  --data '{ "language": "en" }'

Uses AI to generate suggested profile copy for the property based on the supplied request, returning the suggestions for review.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
managingEntityIdentifier
required
string
""

Suggest for this property identifier

Example 
e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18

Header Parameters

Section titled “Header Parameters ”
Wink-Version
string
default: 2.0.0
Allowed values: 2.0

Request Body required

Section titled “Request Body required ”

Seed information and preferences used by AI to generate profile copy suggestions for the property

Media type application/json
object
language
required

Language to use

string
"" >= 1 characters
Example 
en
Example 
{
  "language": "en"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

AI-generated profile copy suggestions for review before saving

Media type application/json

AI-suggested profile data for a property, derived from demographic analysis

object
website
required

Website URL of the property

string
""
ambiance
required

Property ambiance and atmosphere

string
""
address1

Primary address line

string
""
address2

Secondary address line (apartment, suite, etc.)

string
""
address3

Tertiary address line

string
""
city

City name

string
""
province

Province or state

string
""
postalCode

Postal or zip code

string
""
country

Country name

string
""
phoneNumber

Contact phone number

string
""
emailAddress

Contact email address

string
""
architecture

Architectural style (e.g., Contemporary, Colonial, Art Deco)

string
""
designElements

Key design elements and aesthetic features

string
""
historic

Historical significance or heritage status

string
""
numberOfRooms

Total number of rooms available

string
""
hotelStars

Star rating of the property

string
""
locationCategory

Location category code

string
""
segment

Market segment (e.g., Luxury, Boutique, Business)

string
""
propertyClass

Property classification code

string
""
style

Architectural/design style code

string
""
chain

Hotel chain affiliation if applicable

string
""
brand

Brand or brand identity

string
""
yearBuilt

Year the property was built or renovated

string
""
key
additional properties
""
Example 
{
  "website": "https://www.thesiamresidences.com",
  "ambiance": "Serene tropical oasis with contemporary design and personalized service",
  "address1": "1 Khlang Toei Road",
  "address2": "",
  "address3": "",
  "city": "Bangkok",
  "province": "Central",
  "postalCode": "10110",
  "country": "Thailand",
  "phoneNumber": "+66 2 126 8866",
  "emailAddress": "[email protected]",
  "architecture": "Contemporary",
  "designElements": "Minimalist with natural materials and tropical accents",
  "historic": "Built in 2015, newly renovated in 2022",
  "numberOfRooms": "48",
  "hotelStars": "5",
  "locationCategory": "MTR",
  "segment": "Luxury",
  "propertyClass": "RES",
  "style": "MOD",
  "chain": "Independent",
  "brand": "The Siam Residences",
  "yearBuilt": "2015"
}

400

Section titled “400 ”

Bad Request — missing or invalid request parameter or body

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example

401

Section titled “401 ”

Unauthorized — authentication is required or the session has expired

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example

403

Section titled “403 ”

Forbidden — authenticated but lacking the required permission or scope

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example

404

Section titled “404 ”

Not Found — the requested resource does not exist

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example

405

Section titled “405 ”

Method Not Allowed — the HTTP verb is not supported on this endpoint

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example

415

Section titled “415 ”

Unsupported Media Type — use application/json

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example

500

Section titled “500 ”

Internal Server Error — an unexpected failure occurred on the server

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example

503

Section titled “503 ”

Service Unavailable — a downstream dependency is unreachable

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example