Skip to content

Suggest amenities

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

Returns AI-suggested amenities as selectable key/value pairs for the property.

managingEntityIdentifier
required
string
""

Suggest for this property identifier

Example
e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18
Wink-Version
string
default: 2.0.0
Allowed values: 2.0

Context payload with property description and category hints used by the AI model to generate relevant amenity suggestions

Media type application/json
object
language
required

Language to use

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

AI-suggested amenities as a list of selectable key/value pairs

Media type application/json

Immutable key-value pair associating a machine-readable value with a human-readable label.

object
value
required

The value that should be persisted.

string
"" >= 1 characters
label
required

English readable text of the value.

string
"" >= 1 characters
key
additional properties
""
Example
{
"value": "HOTEL",
"label": "Hotel & Resort"
}

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

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

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

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

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

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

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

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