Skip to content

Get AI-suggested amenities for lead

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

Returns AI-suggested property amenities as selectable key/value pairs for the lead. These suggestions are based on the lead’s details, location, and type. You can select which amenities apply to your property.

leadIdentifier
required
string
""

Unique identifier of the lead to suggest amenities 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

Suggested amenities returned successfully

Media type application/json
Array<object>
object
value
required

The value that should be persisted.

string
"" >= 1 characters
label
required

English readable text of the value.

string
"" >= 1 characters
Example
[
{
"value": "",
"label": ""
}
]

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
Array<object>
object
value
required

The value that should be persisted.

string
"" >= 1 characters
label
required

English readable text of the value.

string
"" >= 1 characters
Example
[
{
"value": "",
"label": ""
}
]

Internal Server Error

object
Example generated
{}