Skip to content

Improve room copy with AI

PUT
/api/managing-entity/{managingEntityIdentifier}/extranet/facility/room-type/{roomTypeIdentifier}/improve
curl --request PUT \
--url https://api.wink.travel/api/managing-entity/e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18/extranet/facility/room-type/6f9b4c8d-1e5a-4b3c-9d2e-8a7f0c1b5e43/improve \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Wink-Version: 2.0' \
--data null

Uses AI to enhance the room type’s descriptive text and related copy, returning the suggested improvements. Requires INVENTORY:WRITE on the property.

managingEntityIdentifier
required
string format: uuid
""

Property identifier that owns the room type.

Example
e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18
roomTypeIdentifier
required
string format: uuid
""

Room type identifier to improve.

Example
6f9b4c8d-1e5a-4b3c-9d2e-8a7f0c1b5e43
Wink-Version
string
default: 2.0.0
Allowed values: 2.0

AI improvement request carrying the existing room type copy and locale preferences so the AI can enhance descriptions and marketing text

Media typeapplication/json

Request payload supplying the existing room type title and description for AI-driven copy improvement.

object
description

Existing room type description to be improved by AI.

string
""
Example
A spacious deluxe room with stunning ocean views, king bed, and private balcony.
title

Existing room type title to be improved by AI.

string
""
Example
Deluxe Ocean View Room
Example
{
"description": "A spacious deluxe room with stunning ocean views, king bed, and private balcony.",
"title": "Deluxe Ocean View Room"
}

AI-improved room type copy returned successfully.

Media typeapplication/json

AI-generated improvements for the room type title and descriptive copy.

object
description

AI-improved room type description.

string
""
title
required

AI-improved room type title.

string
""
key
additional properties
""
Example
{
"description": "Indulge in breathtaking panoramic ocean views from this elegantly appointed deluxe suite, featuring a plush king bed, a private balcony, and refined Thai-inspired décor.",
"title": "Spectacular Deluxe Ocean-View Suite"
}

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
key
additional properties
""
Example

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
key
additional properties
""
Example

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
key
additional properties
""
Example

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
key
additional properties
""
Example

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
key
additional properties
""
Example

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
key
additional properties
""
Example

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
key
additional properties
""
Example

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
key
additional properties
""
Example

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
key
additional properties
""
Example