Skip to content

Generate AI-suggested property profile for lead

POST
/api/lead/{leadIdentifier}/profile/suggest
curl --request POST \
--url https://api.wink.travel/api/lead/f8c4e2a7-3d5b-4a9c-8e1f-2b6d9a0c5f47/profile/suggest \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Wink-Version: 2.0' \
--data '{ "language": "" }'

Generates a comprehensive AI-drafted property profile for the lead including descriptions, amenities, and metadata derived from the lead details and context you provide. This profile can be reviewed and edited before saving to the property.

leadIdentifier
required
string
""

Unique identifier of the lead to generate profile suggestions for

Example
f8c4e2a7-3d5b-4a9c-8e1f-2b6d9a0c5f47
Wink-Version
string
default: 2.0.0
Allowed values: 2.0
Media type application/json
object
language
required

Language to use

string
"" >= 1 characters
Example
en

AI-suggested profile generated successfully

Media type application/json
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
""
Example
{
"website": "",
"ambiance": "",
"address1": "",
"address2": "",
"address3": "",
"city": "",
"province": "",
"postalCode": "",
"country": "",
"phoneNumber": "",
"emailAddress": "",
"architecture": "",
"designElements": "",
"historic": "",
"numberOfRooms": "",
"hotelStars": "",
"locationCategory": "",
"segment": "",
"propertyClass": "",
"style": "",
"chain": "",
"brand": "",
"yearBuilt": ""
}

Bad Request

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"
}
}

Unauthorized

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

Lead not found

Media type application/json
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
""
Example
{
"website": "",
"ambiance": "",
"address1": "",
"address2": "",
"address3": "",
"city": "",
"province": "",
"postalCode": "",
"country": "",
"phoneNumber": "",
"emailAddress": "",
"architecture": "",
"designElements": "",
"historic": "",
"numberOfRooms": "",
"hotelStars": "",
"locationCategory": "",
"segment": "",
"propertyClass": "",
"style": "",
"chain": "",
"brand": "",
"yearBuilt": ""
}

Internal Server Error

object
Example generated
{}