Create from external URL
const url = 'https://api.wink.travel/api/managing-entity/d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69/wink-links/shortened-url/consume-external-url';const options = { method: 'POST', headers: { 'Wink-Version': '2.0', Authorization: 'Bearer <token>', 'Content-Type': 'application/json' }, body: 'null'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://api.wink.travel/api/managing-entity/d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69/wink-links/shortened-url/consume-external-url \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --header 'Wink-Version: 2.0' \ --data nullScrapes Open Graph metadata from an external URL and creates a shortened URL entry from it.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”Managing entity that will own the shortened URL
Example
d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69Header Parameters
Section titled “Header Parameters ”Request Body required
Section titled “Request Body required ”External URL to scrape for Open Graph metadata and optional syndication flag
Request to scrape an external URL for Open Graph metadata and optionally create a social media post
object
External URL to scrape for Open Graph metadata and create a shortened URL from
Example
https://www.thesiamresidences.com/luxury-stayWhether to automatically create a syndicated social media post based on the scraped content
Example
falseExample
{ "url": "https://www.thesiamresidences.com/luxury-stay", "createPost": false}Responses
Section titled “ Responses ”Shortened URL created from the external URL’s Open Graph metadata
A shortened URL entry that maps a URL-friendly slug to a destination URL or inventory entity, supporting Open Graph metadata and localized descriptions
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 this shortened URL
Managing entity / Owner identifier that owns this shortened URL
Display name of the shortened URL
Type of entity the uniqueId links to (URL, PROPERTY, BOOKING, etc.)
URL-friendly slug that uniquely identifies this entry within the owner’s account
Entity identifier that the uniqueId originates from. Omit for type=URL, required for other types.
Target URL to redirect to. Required when type=URL, omit for other types.
Open Graph images extracted from the target URL
object
URL of the media asset
HTTPS URL of the media asset
MIME type of the media (image/jpeg, video/mp4, audio/mpeg, etc.)
Media width in pixels
Media height in pixels
Alternative text description for accessibility
Open Graph videos extracted from the target URL
object
URL of the media asset
HTTPS URL of the media asset
MIME type of the media (image/jpeg, video/mp4, audio/mpeg, etc.)
Media width in pixels
Media height in pixels
Alternative text description for accessibility
Open Graph audio media extracted from the target URL
object
URL of the media asset
HTTPS URL of the media asset
MIME type of the media (image/jpeg, video/mp4, audio/mpeg, etc.)
Media width in pixels
Media height in pixels
Alternative text description for accessibility
Localized descriptions of the shortened URL entry
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
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.
Primary media assets associated with this shortened URL
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.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
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 key-value pairs (e.g., seo keywords, tags)
object
Example
{ "id": "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "createdDate": "2026-01-14T09:30:00", "lastUpdate": "2026-01-15T10:00:00", "userIdentifier": "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "ownerIdentifier": "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "title": "The Siam Residences, Bangkok", "type": "URL", "uniqueId": "the-siam-residences-promo", "url": "https://www.thesiamresidences.com/luxury-stay", "descriptions": [ { "language": "en", "description": "Luxury residential resort featuring private suites, spa facilities, and fine dining experiences in the heart of Bangkok." } ], "imageList": [], "videoList": [], "audioList": [], "multimedias": [], "previousUniqueIds": []}Bad Request — missing or invalid request parameter or body
object
object
Example
Unauthorized — authentication is required or the session has expired
object
object
Example
Forbidden — authenticated but lacking the required permission or scope
object
object
Example
Not Found — the requested resource does not exist
object
object
Example
Method Not Allowed — the HTTP verb is not supported on this endpoint
object
object
Example
Unsupported Media Type — use application/json
object
object
Example
Internal Server Error — an unexpected failure occurred on the server
object
object
Example
Service Unavailable — a downstream dependency is unreachable