Upsert WinkLinks Settings
const url = 'https://api.wink.travel/api/managing-entity/owner-1/wink-links/syndication/settings';const options = { method: 'PUT', headers: {'Wink-Version': '2.0', 'Content-Type': 'application/json'}, body: '{"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"}'};
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/syndication/settings \ --header 'Content-Type: application/json' \ --header 'Wink-Version: 2.0' \ --data '{ "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" }'Upsert a new syndication settings.
Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”Update settings for this managing entity identifier.
Example
owner-1Header Parameters
Section titled “Header Parameters ”Request Body required
Section titled “Request Body required ”Request body
object
Whether to treat all links as flat web links or try to embed more advanced data.
Example
Embedding a tweetCustomization identifier
Example
customization-1Which way to display the list when WinkLinks first loads
Example
LISTControls how to display profile picture
Example
CIRCLEWhere to show the online presence icons
Example
BOTTOMCustomizable QR code options
object
Custom image ID for subscribers
Example
abc123QR code shape
Example
CIRCLEQR code shape
Example
SQUAREDots round size
Example
trueDots gradient
Example
LINEARDots gradient rotation
Example
5Dots primary color
Example
#000000Dots gradient color
Example
#FFFFFFCorner square type
Example
SQUARECorners square gradient
Example
LINEARCorners square gradient rotation
Example
5Corner square primary color
Example
#000000Corner square gradient color
Example
#FFFFFFCorner dot type
Example
SQUARECorners dot gradient
Example
LINEARCorners dot gradient rotation
Example
5Corner dot primary color
Example
#000000Corner dot gradient color
Example
#FFFFFFCorner square type
Example
0Corners square gradient
Example
LINEARCorners square gradient rotation
Example
5Corner square primary color
Example
#000000Corner square gradient color
Example
#FFFFFFTheme colors are connected with the primary account customization.
object
Primary color
Example
#dc3545Secondary color
Example
#6c757dSuccess color
Example
#28a745Danger color
Example
#dc3545Warning color
Example
#ffc107Info color
Example
#17a2b8Light color
Example
#f8f9faDark color
Example
#343a40Body color
Example
#212529Muted color
Example
#6c757dWhite color
Example
#ffffffWhether the mobile gradient background is enabled
Mobile gradient type
Example
LINEARMobile gradient angle in degrees (0-360)
Example
180Mobile background image
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
trueWhether the desktop gradient background is enabled
Desktop gradient type
Example
LINEARDesktop gradient angle in degrees (0-360)
Example
180Desktop background image
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
trueProfile picture size for circle and rectangle geometries
Example
MDAccount name heading size
Example
LGCustom font for account name display
Mobile background pattern type
Desktop background pattern type
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
{}