Update Shortened Url
const url = 'https://api.wink.travel/api/managing-entity/owner-1/wink-links/shortened-url/shortened-url-1';const options = { method: 'PUT', headers: {'Wink-Version': '2.0', 'Content-Type': 'application/json'}, body: '{"title":"","type":"SELLABLE_INVENTORY_SLUG","uniqueId":"","entityId":"","url":"","imageList":"","videoList":"","audioList":"","descriptions":[""],"multimedias":"","metadata":""}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PUT \ --url https://api.wink.travel/api/managing-entity/owner-1/wink-links/shortened-url/shortened-url-1 \ --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": "" }'Updates an existing shortened url.
Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”Create entry for this owner identifier.
Example
owner-1Shortened Url identifier.
Example
shortened-url-1Header Parameters
Section titled “Header Parameters ”Request Body required
Section titled “Request Body required ”Request body
object
The site name of this entry
Example
GoogleThe type of document the uniqueId links to
This is the unique ID for the specific URL we want to catch
Example
unique-1Entity ID is where the unique ID originated from. This will be empty if it’s just a regular url. Required when type IS NOT URL.
Example
sellable-inventory-url-1For times when the user just wants to shorten a url and there is no underlying entity to speak of. Required when type IS URL.
Example
https://wink.travelThe image list
The media list
object
The image url
Example
https://www.google.com/google.pngThe secure url
Example
https://secure.google.com/google.pngImage content type
Example
image/jpgImage width
Example
1200Image height
Example
630Alt text
Example
Picture of CatThe video list
The media list
object
The image url
Example
https://www.google.com/google.pngThe secure url
Example
https://secure.google.com/google.pngImage content type
Example
image/jpgImage width
Example
1200Image height
Example
630Alt text
Example
Picture of CatThe audio list
The media list
object
The image url
Example
https://www.google.com/google.pngThe secure url
Example
https://secure.google.com/google.pngImage content type
Example
image/jpgImage width
Example
1200Image height
Example
630Alt text
Example
Picture of CatLocalized descriptions describing inventory.
object
Use as title or short text description
Example
An example titleLonger text description
Example
This is a longer description in the specified language.Indicate which language this description is written in.
Example
enWhether it was user or system generated.
Example
SYSTEMThe md5 hash of the name, description and language.
The main media for this entry.
Multimedia that contains less information than Multimedia object
object
Document identifier
Example
image-1Use this identifier to communicate with Cloudinary.
Example
cloudinary-image-1Whether Cloudinary media is a VIDEO or IMAGE.
Example
IMAGECurrently ONLY using Cloudinary to store all image / video assets.
Example
CLOUDINARYSort allows you to control how you want to sort this record in a list of media records.
Example
10Media angle
Example
-90Media width in pixels.
Example
2560Media height in pixels.
Example
1600Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Example
trueLocalized media captions to give user some context about where this media was taken.
object
Use as title or short text description
Example
An example titleLonger text description
Example
This is a longer description in the specified language.Indicate which language this description is written in.
Example
enWhether it was user or system generated.
Example
SYSTEMThe md5 hash of the name, description and language.
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Example
LIFESTYLE_HEALTH_FITNESSWhether image has attribution properties
object
URL to contributor
Example
https://maps.google.com/maps/contrib/111628493169070103594Name of contributor
Example
Samuel AdamsTrue if media width is greater or equal to height
Example
trueExample
For web links, it would be the Open Graph image url. For a file upload, it would be the multipart file.Extended metadata
object
Responses
Section titled “ Responses ”OK
object
Document UUID
Datetime this record was first created
Datetime this record was last updated
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.
Creator of entry
AffiliateAccount / Owner identifier
The site name of this entry
The type of document the uniqueId links to
This is the unique ID for the specific URL we want to catch
Entity ID is where the unique ID originated from. This will be empty if it’s just a regular url. Required when type IS NOT URL.
For times when the user just wants to shorten a url and there is no underlying entity to speak of. Required when type IS URL.
The image list
object
The image url
The secure url
Image content type
Image width
Image height
Alt text
The video list
object
The image url
The secure url
Image content type
Image width
Image height
Alt text
The audio list
object
The image url
The secure url
Image content type
Image width
Image height
Alt text
Localized descriptions describing inventory.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
The main media for this entry.
object
Document identifier
Use this identifier to communicate with Cloudinary.
Whether Cloudinary media is a VIDEO or IMAGE.
Currently ONLY using Cloudinary to store all image / video assets.
Sort allows you to control how you want to sort this record in a list of media records.
Media angle
Media width in pixels.
Media height in pixels.
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Whether image has attribution properties
object
URL to contributor
Name of contributor
True if media width is greater or equal to height
Extended metadata
object
Example
{ "id": "", "createdDate": "", "lastUpdate": "", "version": "", "userIdentifier": "", "ownerIdentifier": "", "title": "", "type": "SELLABLE_INVENTORY_SLUG", "uniqueId": "", "entityId": "", "url": "", "imageList": [ "" ], "videoList": [ "" ], "audioList": [ "" ], "descriptions": [ "" ], "multimedias": [ null ], "metadata": "", "previousUniqueIds": [ "" ]}Bad Request
object
object
Example generated
{ "type": "https://example.com", "title": "example", "status": 1, "detail": "example", "instance": "https://example.com", "properties": { "additionalProperty": "example" }}object
object
object
object
object
object
object
object
Unauthorized
object
object
Forbidden
object
object
Internal Server Error
object
Example generated
{}