Skip to content
Wink

Update

PUT
/api/managing-entity/{managingEntityIdentifier}/wink-links/shortened-url/{shortenedUrlIdentifier}
 
curl --request PUT \
  --url https://api.wink.travel/api/managing-entity/d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69/wink-links/shortened-url/f8c2d4a1-9e3b-4f7c-8d5e-2a6f1b3c0e94 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Wink-Version: 2.0' \
  --data '{ "title": "", "type": "SELLABLE_INVENTORY_SLUG", "uniqueId": "", "entityId": "", "url": "", "imageList": "", "videoList": "", "audioList": "", "descriptions": [ "" ], "multimedias": "", "metadata": "" }'

Edits an existing shortened URL’s slug and target by its identifier.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
managingEntityIdentifier
required
string
""

Managing entity identifier that owns the shortened URL

Example 
d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69
shortenedUrlIdentifier
required
string
""

Identifier of the shortened URL to update

Example 
f8c2d4a1-9e3b-4f7c-8d5e-2a6f1b3c0e94

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 ”

Updated shortened URL details (title, slug, target, metadata)

Media type application/json
object
title
required

Display name for this shortened URL

string
"" >= 1 characters
Example 
The Siam Residences, Bangkok
type
required

Type of entity the uniqueId links to (URL, PROPERTY, BOOKING, etc.)

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

URL-friendly slug that uniquely identifies this entry within the owner’s account

string
"" >= 1 characters
Example 
the-siam-residences-promo
entityId

Entity identifier that the uniqueId originates from. Omit for type=URL, required for other types.

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

Target URL to redirect to. Required when type=URL, omit for other types.

string
""
Example 
https://www.thesiamresidences.com/luxury-stay
imageList

Open Graph images extracted from the target URL

Array<object>
""

Open Graph media asset (image, video, or audio)

object
url
required

URL of the media asset

string
"" >= 1 characters
Example 
https://res.cloudinary.com/traveliko/image/upload/v1689655191/the-siam-residences-bangkok.jpg
secureUrl

HTTPS URL of the media asset

string
""
Example 
https://res.cloudinary.com/traveliko/image/upload/v1689655191/the-siam-residences-bangkok.jpg
type

MIME type of the media (image/jpeg, video/mp4, audio/mpeg, etc.)

string
""
Example 
image/jpeg
width

Media width in pixels

string
""
Example 
1200
height

Media height in pixels

string
""
Example 
630
alt

Alternative text description for accessibility

string
""
Example 
The Siam Residences exterior view
videoList

Open Graph videos extracted from the target URL

Array<object>
""

Open Graph media asset (image, video, or audio)

object
url
required

URL of the media asset

string
"" >= 1 characters
Example 
https://res.cloudinary.com/traveliko/image/upload/v1689655191/the-siam-residences-bangkok.jpg
secureUrl

HTTPS URL of the media asset

string
""
Example 
https://res.cloudinary.com/traveliko/image/upload/v1689655191/the-siam-residences-bangkok.jpg
type

MIME type of the media (image/jpeg, video/mp4, audio/mpeg, etc.)

string
""
Example 
image/jpeg
width

Media width in pixels

string
""
Example 
1200
height

Media height in pixels

string
""
Example 
630
alt

Alternative text description for accessibility

string
""
Example 
The Siam Residences exterior view
audioList

Open Graph audio media extracted from the target URL

Array<object>
""

Open Graph media asset (image, video, or audio)

object
url
required

URL of the media asset

string
"" >= 1 characters
Example 
https://res.cloudinary.com/traveliko/image/upload/v1689655191/the-siam-residences-bangkok.jpg
secureUrl

HTTPS URL of the media asset

string
""
Example 
https://res.cloudinary.com/traveliko/image/upload/v1689655191/the-siam-residences-bangkok.jpg
type

MIME type of the media (image/jpeg, video/mp4, audio/mpeg, etc.)

string
""
Example 
image/jpeg
width

Media width in pixels

string
""
Example 
1200
height

Media height in pixels

string
""
Example 
630
alt

Alternative text description for accessibility

string
""
Example 
The Siam Residences exterior view
descriptions
required

Localized descriptions of the shortened URL entry

Array<object>
>= 1 items
object
name
required

Use as title or short text description

string
""
Example 
An example title
description
required

Longer text description

string
"" >= 1 characters <= 2147483647 characters
Example 
This is a longer description in the specified language.
language
required

Indicate which language this description is written in.

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

Whether it was user or system generated.

string
default: USER
Allowed values: SYSTEM USER
Example 
SYSTEM
md5ContentHash

The md5 hash of the name, description and language.

string
""
hashMismatch
boolean
multimedias

Primary media assets associated with this shortened URL

Array<object>
""

Multimedia that contains less information than Multimedia object

object
multimediaIdentifier
required

Document identifier

string format: uuid
"" >= 1 characters
Example 
image-1
identifier
required

Use this identifier to communicate with Cloudinary.

string
"" >= 1 characters
Example 
cloudinary-image-1
type
required

Whether Cloudinary media is a VIDEO or IMAGE.

string
""
Allowed values: IMAGE VIDEO AUDIO RAW
Example 
IMAGE
source
required

Currently ONLY using Cloudinary to store all image / video assets.

string
default: CLOUDINARY
Allowed values: YOUTUBE CLOUDINARY
Example 
CLOUDINARY
sort
required

Sort allows you to control how you want to sort this record in a list of media records.

integer format: int32
default: 999
Example 
10
angle

Media angle

string
""
Example 
-90
width
required

Media width in pixels.

integer format: int32
"" >= 1
Example 
2560
height
required

Media height in pixels.

integer format: int32
"" >= 1
Example 
1600
published

Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.

boolean
Example 
true
category

Supported OTA specification PIC code. See OTA geoname data

string
""
Example 
1
descriptions

Localized media captions to give user some context about where this media was taken.

Array<object>
""
object
name
required

Use as title or short text description

string
""
Example 
An example title
description
required

Longer text description

string
"" >= 1 characters <= 2147483647 characters
Example 
This is a longer description in the specified language.
language
required

Indicate which language this description is written in.

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

Whether it was user or system generated.

string
default: USER
Allowed values: SYSTEM USER
Example 
SYSTEM
md5ContentHash

The md5 hash of the name, description and language.

string
""
hashMismatch
boolean
lifestyleType

Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.

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_HEALTH_FITNESS
attribution

Whether image has attribution properties

Array<object>
""
object
url

URL to contributor

string
""
Example 
https://maps.google.com/maps/contrib/111628493169070103594
name
required

Name of contributor

string
"" >= 1 characters
Example 
Samuel Adams
isLandscape

True if media width is greater or equal to height

boolean
Example 
true
metadata

Extended metadata key-value pairs (e.g., seo keywords, tags)

object
key
additional properties

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json
object
id

Document UUID

string format: uuid
""
createdDate

Datetime this record was first created

string format: date-time
""
lastUpdate

Datetime this record was last updated

string format: date-time
""
version

Version property that shows how many times this document has been persisted. Document will not persist if the version property is less than current version property in the system. Result in an optimistic locking exception.

integer format: int64
""
userIdentifier
required

Creator of this shortened URL

string format: uuid
"" >= 1 characters
ownerIdentifier
required

Managing entity / Owner identifier that owns this shortened URL

string format: uuid
"" >= 1 characters
title
required

Display name of the shortened URL

string
"" >= 1 characters
type
required

Type of entity the uniqueId links to (URL, PROPERTY, BOOKING, etc.)

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

URL-friendly slug that uniquely identifies this entry within the owner’s account

string
"" >= 1 characters
entityId

Entity identifier that the uniqueId originates from. Omit for type=URL, required for other types.

string format: uuid
""
url

Target URL to redirect to. Required when type=URL, omit for other types.

string
""
imageList
Array<object>

Open Graph images extracted from the target URL

object
url
required

URL of the media asset

string
"" >= 1 characters
secureUrl

HTTPS URL of the media asset

string
""
type

MIME type of the media (image/jpeg, video/mp4, audio/mpeg, etc.)

string
""
width

Media width in pixels

string
""
height

Media height in pixels

string
""
alt

Alternative text description for accessibility

string
""
videoList
Array<object>

Open Graph videos extracted from the target URL

object
url
required

URL of the media asset

string
"" >= 1 characters
secureUrl

HTTPS URL of the media asset

string
""
type

MIME type of the media (image/jpeg, video/mp4, audio/mpeg, etc.)

string
""
width

Media width in pixels

string
""
height

Media height in pixels

string
""
alt

Alternative text description for accessibility

string
""
audioList
Array<object>

Open Graph audio media extracted from the target URL

object
url
required

URL of the media asset

string
"" >= 1 characters
secureUrl

HTTPS URL of the media asset

string
""
type

MIME type of the media (image/jpeg, video/mp4, audio/mpeg, etc.)

string
""
width

Media width in pixels

string
""
height

Media height in pixels

string
""
alt

Alternative text description for accessibility

string
""
descriptions
required

Localized descriptions of the shortened URL entry

Array<object>
>= 1 items
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
multimedias
Array<object>

Primary media assets associated with this shortened URL

object
multimediaIdentifier
required

Document identifier

string format: uuid
"" >= 1 characters
identifier
required

Use this identifier to communicate with Cloudinary.

string
"" >= 1 characters
type
required

Whether Cloudinary media is a VIDEO or IMAGE.

string
""
Allowed values: IMAGE VIDEO AUDIO RAW
source
required

Currently ONLY using Cloudinary to store all image / video assets.

string
default: CLOUDINARY
Allowed values: YOUTUBE CLOUDINARY
sort
required

Sort allows you to control how you want to sort this record in a list of media records.

integer format: int32
default: 999
angle

Media angle

string
""
width
required

Media width in pixels.

integer format: int32
"" >= 1
height
required

Media height in pixels.

integer format: int32
"" >= 1
published

Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.

boolean
category

Supported OTA specification PIC code. See OTA geoname data

string
""
descriptions

Localized media captions to give user some context about where this media was taken.

Array<object>
""
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
lifestyleType

Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.

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
attribution

Whether image has attribution properties

Array<object>
""
object
url

URL to contributor

string
""
name
required

Name of contributor

string
"" >= 1 characters
isLandscape

True if media width is greater or equal to height

boolean
metadata

Extended metadata key-value pairs (e.g., seo keywords, tags)

object
key
additional properties
previousUniqueIds
Array<string>
Example 
{
  "id": "",
  "createdDate": "",
  "lastUpdate": "",
  "version": "",
  "userIdentifier": "",
  "ownerIdentifier": "",
  "title": "",
  "type": "SELLABLE_INVENTORY_SLUG",
  "uniqueId": "",
  "entityId": "",
  "url": "",
  "imageList": [
    ""
  ],
  "videoList": [
    ""
  ],
  "audioList": [
    ""
  ],
  "descriptions": [
    ""
  ],
  "multimedias": [
    null
  ],
  "metadata": "",
  "previousUniqueIds": [
    ""
  ]
}

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

500

Section titled “500 ”

Internal Server Error

object
Example generated
{}