Skip to content
Wink

Show shareable link

POST
/api/public/shareable-link/{code}
 
curl --request POST \
  --url 'https://api.wink.travel/api/public/shareable-link/WNK7A?cid=summer-promo-2026&_gl=' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Host: ' \
  --header 'Referer: ' \
  --header 'User-Agent: ' \
  --header 'Wink-Version: 2.0' \
  --data null

Resolves a 5-character share code into its bookable inventory, merging the posted user session and the caller’s geo-IP location, and records a view.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
code
required
string
""

Five-character share code for the shortened URL

Example 
WNK7A

Header Parameters

Section titled “Header Parameters ”
User-Agent
string
""

User-Agent header from the request

Host
string
""

Host header from the request

Referer
string
""

Referrer header from the request

Wink-Version
string
default: 2.0.0
Allowed values: 2.0

Query Parameters

Section titled “Query Parameters ”
cid
string
""

Campaign identifier for tracking purposes

Example 
summer-promo-2026
_gl
string
""

Google Analytics 4 cross-site link ID

Request Body required

Section titled “Request Body required ”

User session context including itinerary dates, room configuration, currency, language, and geo-IP location

Media type application/json

User session information containing itinerary and other user related data.

object
itinerary
required

Dates and travel info.

object
startDate
required

Check-in date (must be today or in the future)

string format: date
""
Example 
2026-07-15
endDate

Check-out date (alternative to nights; nights takes precedence if both provided)

string format: date
""
Example 
2026-07-18
nights

Number of nights for the stay (alternative to endDate; takes precedence if both provided)

integer format: int32
0
Example 
3
items
required

Room configurations for each room in the reservation

Array<object>
>= 1 items <= 2147483647 items

Room occupancy and guest composition for a single or multiple identical rooms

object
adults
required

Number of adult guests in this room type

integer format: int32
default: 1 >= 1
Example 
2
children

Child guests in this room, with age groups

Array<object>

Child guest with age and quantity in a room configuration

object
quantity
required

Count of children of this age group in the room

integer format: int32
"" >= 1
Example 
2
age
required

Age of each child in this group (years)

integer format: int32
""
Example 
7
Example 
{
  "quantity": 2,
  "age": 7
}
quantity

Number of identical rooms with this configuration

integer format: int32
default: 1 >= 1
Example 
1
Example 
{
  "adults": 2,
  "children": [
    {
      "quantity": 2,
      "age": 7
    }
  ],
  "quantity": 1
}
hours

Duration in hours (rounded up) between check-in and check-out. Used for hourly bookings; e.g., meeting rooms or day-use venues.

integer format: int64
""
Example 
72
children

Total number of children across all rooms

integer format: int32
""
Example 
1
guests

Total number of adult guests across all rooms

integer format: int32
""
Example 
4
rooms

Total number of rooms in this itinerary

integer format: int32
""
Example 
2
Example 
{
  "startDate": "2026-07-15",
  "endDate": "2026-07-18",
  "nights": 3,
  "items": [
    {
      "adults": 2,
      "children": [
        {
          "quantity": 2,
          "age": 7
        }
      ],
      "quantity": 1
    }
  ],
  "hours": 72,
  "children": 1,
  "guests": 4,
  "rooms": 2
}
language

User’s language preference (ISO 639-1 code)

string
""
Example 
en
currency

User’s currency preference (ISO 4217 code)

string
""
Example 
USD
promotionalCodes
Array<string>
selectedRoomConfigurationIndex

Index of the currently selected room configuration for rate retrieval

integer format: int32
0
Example 
0
lifestyle

Preferred lifestyle category to filter accommodations

string
""
Allowed values: LIFESTYLE_HEALTH_FITNESS LIFESTYLE_RELAX LIFESTYLE_ADULT_ONLY LIFESTYLE_ADVENTURE LIFESTYLE_BUSINESS LIFESTYLE_LGBT LIFESTYLE_SINGLE_PARENT LIFESTYLE_SOLO_FEMALE LIFESTYLE_BEAUTY LIFESTYLE_FOODIE LIFESTYLE_FAMILY LIFESTYLE_ROMANCE LIFESTYLE_COUPLE LIFESTYLE_SOLO LIFESTYLE_BACKPACKER LIFESTYLE_SHOPPING LIFESTYLE_SPORTS LIFESTYLE_MOUNTAIN LIFESTYLE_BEACH LIFESTYLE_CITY LIFESTYLE_COUNTRY LIFESTYLE_CULTURE LIFESTYLE_ECO
Example 
LIFESTYLE_RELAX
Example 
{
  "itinerary": {
    "startDate": "2026-07-15",
    "endDate": "2026-07-18",
    "nights": 3,
    "items": [
      {
        "adults": 2,
        "children": [
          {
            "quantity": 2,
            "age": 7
          }
        ],
        "quantity": 1
      }
    ],
    "hours": 72,
    "children": 1,
    "guests": 4,
    "rooms": 2
  },
  "language": "en",
  "currency": "USD",
  "promotionalCodes": [
    "SUMMER2026"
  ],
  "selectedRoomConfigurationIndex": 0,
  "lifestyle": "LIFESTYLE_RELAX"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Resolved bookable inventory with Open Graph metadata and booking URL

Media type application/json

Base class for Open Graph redirect URL metadata used to generate rich social sharing links

object
type
required

The type of document the uniqueId links to

string
""
Allowed values: SELLABLE_INVENTORY_SLUG SELLABLE_SUPPLIER_SLUG AFFILIATE_ACCOUNT_SLUG SYNDICATED_ITEM_SLUG URL
language
required

Which language the seller wanted to use

string
default: en >= 1 characters
currency

Which currency the seller is using

string
default: USD
title
required

Link title

string
"" >= 1 characters
description
required

Link description

string
"" >= 1 characters
keywords

Comma-separated keyword values that can be used to populate HTML metadata

string
""
uniqueId
required

The URL ID that uniquely represents this link

string
"" >= 1 characters
twitterAccount

Optional X account ID

string
""
facebookAppId

Optional Facebook app ID

string
""
thirdPartyGoogleMeasurementId

Optional 3rd party GA4 Measurement ID

string
""
thirdPartyGoogleTagManagerContainerId

Optional 3rd party GTM Container ID

string
""
image

The image you want to accompany this link

object
channel

Social media channel used for sharing or promoting inventory

string
Allowed values: FACEBOOK INSTAGRAM LINKED_IN TWITTER REDDIT
url
string
width
integer format: int32
height
integer format: int32
type

Type of media asset associated with a seller URL or inventory item

string
Allowed values: IMAGE VIDEO
mimeType
string
altText
string
video

The video you want to accompany this link

object
channel

Social media channel used for sharing or promoting inventory

string
Allowed values: FACEBOOK INSTAGRAM LINKED_IN TWITTER REDDIT
url
string
width
integer format: int32
height
integer format: int32
type

Type of media asset associated with a seller URL or inventory item

string
Allowed values: IMAGE VIDEO
mimeType
string
altText
string
transactUrl
required

The transation url, or where to redirect to when clicking the CTA button.

string
"" >= 1 characters
key
additional properties
""
Example 
{
  "type": "SELLABLE_INVENTORY_SLUG",
  "language": "en",
  "currency": "USD",
  "title": "Luxury Bangkok Retreat - The Siam Residences",
  "description": "Discover exclusive offers at The Siam Residences - luxury residences in the heart of Bangkok with 5-star amenities and world-class service.",
  "keywords": "luxury hotel,Bangkok,residences,5-star,Thailand",
  "uniqueId": "WNK4ZQ7P",
  "twitterAccount": "SiamResidencesBKK",
  "facebookAppId": "1234567890123456",
  "thirdPartyGoogleMeasurementId": "G-ABC1D2E3F4G5H6I7",
  "thirdPartyGoogleTagManagerContainerId": "GTM-ABCD1234",
  "image": {
    "channel": "FACEBOOK",
    "url": "https://res.cloudinary.com/traveliko/image/upload/c_fill,g_auto,h_630,w_1200/v1494580393/siam-residences/lobby.png",
    "width": 1200,
    "height": 630,
    "type": "IMAGE",
    "mimeType": "image/png",
    "altText": "The Siam Residences lobby entrance"
  },
  "video": null,
  "transactUrl": "https://wink.travel/properties/the-siam-residences-bangkok-thailand"
}

400

Section titled “400 ”

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

401

Section titled “401 ”

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

403

Section titled “403 ”

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

404

Section titled “404 ”

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

405

Section titled “405 ”

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

415

Section titled “415 ”

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

500

Section titled “500 ”

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

503

Section titled “503 ”

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