Show WinkLinks Settings
const url = 'https://api.wink.travel/api/managing-entity/owner-1/wink-links/syndication/settings';const options = {method: 'GET', headers: {'Wink-Version': '2.0'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://api.wink.travel/api/managing-entity/owner-1/wink-links/syndication/settings \ --header 'Wink-Version: 2.0'Load WinkLinks settings.
Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”List syndication entries owned by this managing entity identifier.
Example
owner-1Header Parameters
Section titled “Header Parameters ”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
The user’s owner company this entry associates with
Whether to treat all links as flat web links or try to embed more advanced data.
Customization identifier
Which way to itemDisplay the list when WinkLinks first loads
Controls how to itemDisplay profile picture
Where to show the online presence icons
Customizable QR code options
object
Custom image ID for subscribers
QR code shape
QR code shape
Dots round size
Dots gradient
Dots gradient rotation
Dots primary color
Dots gradient color
Corner square type
Corners square gradient
Corners square gradient rotation
Corner square primary color
Corner square gradient color
Corner dot type
Corners dot gradient
Corners dot gradient rotation
Corner dot primary color
Corner dot gradient color
Corner square type
Corners square gradient
Corners square gradient rotation
Corner square primary color
Corner square gradient color
Theme colors are connected with the primary account customization.
object
Primary color
Secondary color
Success color
Danger color
Warning color
Info color
Light color
Dark color
Body color
Muted color
White color
Whether the mobile gradient background is enabled
Mobile gradient type
Mobile gradient angle in degrees (0-360)
Mobile background image
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
Whether the desktop gradient background is enabled
Desktop gradient type
Desktop gradient angle in degrees (0-360)
Desktop background image
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
Profile picture size for circle and rectangle geometries
Account name heading size
Custom font for account name display
Mobile background pattern type
Desktop background pattern type
Example
{ "id": "", "createdDate": "", "lastUpdate": "", "version": "", "userIdentifier": "", "ownerIdentifier": "", "itemDisplay": "FROM_LAYOUT", "customizationIdentifier": "", "layoutDisplay": "LIST", "profilePictureGeometry": "CIRCLE", "onlinePresencePosition": "TOP", "qrCodeOptions": "", "themeColors": "", "mobileGradientEnabled": false, "mobileGradientType": "LINEAR", "mobileGradientAngle": 180, "mobileBackgroundImage": null, "desktopGradientEnabled": false, "desktopGradientType": "LINEAR", "desktopGradientAngle": 180, "desktopBackgroundImage": null, "profilePictureSize": "SM", "accountNameSize": "SM", "fontId": "UI_SANS_SERIF", "mobilePattern": "GRID", "desktopPattern": "GRID"}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
{}