Skip to content
Wink

Generate AI-suggested welcome text for lead

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

Uses AI to generate professional and compelling welcome text and property description copy for the lead based on its details. The suggestions are auto-drafted and can be edited before saving.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
leadIdentifier
required
string
""

Unique identifier of the lead to generate suggestions for

Example 
f8c4e2a7-3d5b-4a9c-8e1f-2b6d9a0c5f47

Header Parameters

Section titled “Header Parameters ”
Wink-Version
string
default: 2.0.0
Allowed values: 2.0

Request Body required

Section titled “Request Body required ”
Media type application/json
object
language
required

Language to use

string
"" >= 1 characters
Example 
en

Responses

Section titled “ Responses ”

200

Section titled “200 ”

AI-suggested welcome text generated successfully

Media type application/json
object
name
required

Use as title or short text description

string
""
description
required

Longer text description

string
"" >= 1 characters <= 2147483647 characters
language
required

Indicate which language this description is written in.

string
default: en >= 2 characters <= 2 characters
creator

Whether it was user or system generated.

string
default: USER
Allowed values: SYSTEM USER
md5ContentHash

The md5 hash of the name, description and language.

string
""
hashMismatch
boolean
Example 
{
  "name": "",
  "description": "",
  "language": "en",
  "creator": "SYSTEM",
  "md5ContentHash": ""
}

400

Section titled “400 ”

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

401

Section titled “401 ”

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

403

Section titled “403 ”

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

404

Section titled “404 ”

Lead not found

Media type application/json
object
name
required

Use as title or short text description

string
""
description
required

Longer text description

string
"" >= 1 characters <= 2147483647 characters
language
required

Indicate which language this description is written in.

string
default: en >= 2 characters <= 2 characters
creator

Whether it was user or system generated.

string
default: USER
Allowed values: SYSTEM USER
md5ContentHash

The md5 hash of the name, description and language.

string
""
hashMismatch
boolean
Example 
{
  "name": "",
  "description": "",
  "language": "en",
  "creator": "SYSTEM",
  "md5ContentHash": ""
}

500

Section titled “500 ”

Internal Server Error

object
Example generated
{}