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 Bodyrequired

Section titled “Request Bodyrequired”

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

Media typeapplication/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 typeapplication/json

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

object
address1

Primary address line

string
address2

Secondary address line (apartment, suite, etc.)

string
address3

Tertiary address line

string
ambiance
required

Property ambiance and atmosphere

string
architecture

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

string
brand

Brand or brand identity

string
chain

Hotel chain affiliation if applicable

string
city

City name

string
country

Country name

string
designElements

Key design elements and aesthetic features

string
emailAddress

Contact email address

string
historic

Historical significance or heritage status

string
hotelStars

Star rating of the property

string
locationCategory

Location category code

string
numberOfRooms

Total number of rooms available

string
phoneNumber

Contact phone number

string
postalCode

Postal or zip code

string
propertyClass

Property classification code

string
province

Province or state

string
segment

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

string
style

Architectural/design style code

string
website
required

Website URL of the property

string
yearBuilt

Year the property was built or renovated

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

400

Section titled “400”

Bad Request — missing or invalid request parameter or body

Media typeapplication/problem+json
object
detail
string
instance
string format: uri
properties
object
key
additional properties
status
integer format: int32
title
string
type
string format: uri
Examplegenerated
{
  "detail": "example",
  "instance": "https://example.com",
  "properties": {
    "additionalProperty": "example"
  },
  "status": 1,
  "title": "example",
  "type": "https://example.com"
}

401

Section titled “401”

Unauthorized — authentication is required or the session has expired

Media typeapplication/problem+json
object
detail
string
instance
string format: uri
properties
object
key
additional properties
status
integer format: int32
title
string
type
string format: uri
Examplegenerated
{
  "detail": "example",
  "instance": "https://example.com",
  "properties": {
    "additionalProperty": "example"
  },
  "status": 1,
  "title": "example",
  "type": "https://example.com"
}

403

Section titled “403”

Forbidden — authenticated but lacking the required permission or scope

Media typeapplication/problem+json
object
detail
string
instance
string format: uri
properties
object
key
additional properties
status
integer format: int32
title
string
type
string format: uri
Examplegenerated
{
  "detail": "example",
  "instance": "https://example.com",
  "properties": {
    "additionalProperty": "example"
  },
  "status": 1,
  "title": "example",
  "type": "https://example.com"
}

404

Section titled “404”

Not Found — the requested resource does not exist

Media typeapplication/problem+json
object
detail
string
instance
string format: uri
properties
object
key
additional properties
status
integer format: int32
title
string
type
string format: uri
Examplegenerated
{
  "detail": "example",
  "instance": "https://example.com",
  "properties": {
    "additionalProperty": "example"
  },
  "status": 1,
  "title": "example",
  "type": "https://example.com"
}

405

Section titled “405”

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

Media typeapplication/problem+json
object
detail
string
instance
string format: uri
properties
object
key
additional properties
status
integer format: int32
title
string
type
string format: uri
Examplegenerated
{
  "detail": "example",
  "instance": "https://example.com",
  "properties": {
    "additionalProperty": "example"
  },
  "status": 1,
  "title": "example",
  "type": "https://example.com"
}

409

Section titled “409”

Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version

Media typeapplication/problem+json
object
detail
string
instance
string format: uri
properties
object
key
additional properties
status
integer format: int32
title
string
type
string format: uri
Examplegenerated
{
  "detail": "example",
  "instance": "https://example.com",
  "properties": {
    "additionalProperty": "example"
  },
  "status": 1,
  "title": "example",
  "type": "https://example.com"
}

415

Section titled “415”

Unsupported Media Type — use application/json

Media typeapplication/problem+json
object
detail
string
instance
string format: uri
properties
object
key
additional properties
status
integer format: int32
title
string
type
string format: uri
Examplegenerated
{
  "detail": "example",
  "instance": "https://example.com",
  "properties": {
    "additionalProperty": "example"
  },
  "status": 1,
  "title": "example",
  "type": "https://example.com"
}

500

Section titled “500”

Internal Server Error — an unexpected failure occurred on the server

Media typeapplication/problem+json
object
detail
string
instance
string format: uri
properties
object
key
additional properties
status
integer format: int32
title
string
type
string format: uri
Examplegenerated
{
  "detail": "example",
  "instance": "https://example.com",
  "properties": {
    "additionalProperty": "example"
  },
  "status": 1,
  "title": "example",
  "type": "https://example.com"
}

503

Section titled “503”

Service Unavailable — a downstream dependency is unreachable

Media typeapplication/problem+json
object
detail
string
instance
string format: uri
properties
object
key
additional properties
status
integer format: int32
title
string
type
string format: uri
Examplegenerated
{
  "detail": "example",
  "instance": "https://example.com",
  "properties": {
    "additionalProperty": "example"
  },
  "status": 1,
  "title": "example",
  "type": "https://example.com"
}