Skip to content

Upsert

PUT
/api/managing-entity/{managingEntityIdentifier}/wink-links/syndication/settings
curl --request PUT \
--url https://api.wink.travel/api/managing-entity/d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69/wink-links/syndication/settings \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Wink-Version: 2.0' \
--data null

Create or replace the account’s WinkLinks syndication settings.

managingEntityIdentifier
required
string
""

Update settings for this managing entity identifier.

Example
d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69
Wink-Version
string
default: 2.0.0
Allowed values: 2.0

WinkLinks settings to create or update

Media typeapplication/json

Request payload for creating or updating the display and layout settings for a WinkLinks profile page.

object
accountNameSize

Account name heading size

string
default: LG
Allowed values: SM MD LG XL
Example
LG
customizationIdentifier
required

Customization identifier for this WinkLinks account

string format: uuid
"" >= 1 characters
Example
b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47
desktopBackgroundImage

Desktop background image

object
angle

Media angle

string
""
Example
-90
attribution

Whether image has attribution properties

Array<object>
""
object
name
required

Name of contributor

string
"" >= 1 characters
Example
Samuel Adams
url

URL to contributor

string format: uri
""
Example
https://maps.google.com/maps/contrib/111628493169070103594
Example
{
"name": "Samuel Adams",
"url": "https://maps.google.com/maps/contrib/111628493169070103594"
}
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>
""

Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.

object
creator

Whether it was user or system generated.

string
default: USER
Allowed values: SYSTEM USER
Example
SYSTEM
description
required

Longer text description

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

Indicate which language this description is written in.

string
default: en >= 2 characters <= 2 characters /^[a-z]{2}(-[A-Z]{2})?$/
Example
en
md5ContentHash

The md5 hash of the name, description and language.

string
""
Example
d41d8cd98f00b204e9800998ecf8427e
name
required

Use as title or short text description

string
""
Example
An example title
Example
{
"creator": "USER",
"description": "Spacious suite with floor-to-ceiling windows overlooking the Chao Phraya River, featuring a king-size bed, private balcony, and marble bathroom.",
"language": "en",
"md5ContentHash": "a3f1c8e2d74b60912a5c3e9b1d7f4e82",
"name": "Deluxe River View Suite"
}
height
required

Media height in pixels.

integer format: int32
"" >= 1
Example
1600
identifier
required

Use this identifier to communicate with Cloudinary.

string
"" >= 1 characters
Example
cloudinary-image-1
isLandscape

True if media width is greater or equal to height

boolean
Example
true
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
multimediaIdentifier
required

Document identifier

string format: uuid
"" >= 1 characters
Example
3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51
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
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
source
required

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

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

Whether Cloudinary media is a VIDEO or IMAGE.

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

Media width in pixels.

integer format: int32
"" >= 1
Example
2560
Example
{
"angle": null,
"attribution": [],
"category": "2",
"descriptions": [
{
"description": "Elegant lobby of The Siam Residences",
"language": "en",
"title": "Lobby Entrance"
}
],
"height": 1600,
"identifier": "the-siam-residences/lobby-entrance",
"isLandscape": true,
"lifestyleType": null,
"multimediaIdentifier": "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51",
"published": true,
"sort": 10,
"source": "CLOUDINARY",
"type": "IMAGE",
"width": 2560
}
desktopGradientAngle

Desktop gradient angle in degrees (0-360)

integer format: int32
default: 180
Example
180
desktopGradientEnabled

Whether the desktop gradient background is enabled

boolean
Example
false
desktopGradientType

Desktop gradient type

string
default: LINEAR
Allowed values: LINEAR RADIAL
Example
LINEAR
desktopPattern

Desktop background pattern type

string
""
Allowed values: GRID DOT_MATRIX DIAGONAL_LINES GRADIENT_MESH CHECKERBOARD
Example
GRID
fontId

Custom font for account name display

string
""
Allowed values: UI_SANS_SERIF UI_SERIF PLAYFAIR_DISPLAY LIBRE_BASKERVILLE CORMORANT_GARAMOND JOSEFIN_SANS RALEWAY LORA SPACE_GROTESK DM_SERIF_DISPLAY OUTFIT CRIMSON_PRO CINZEL BODONI_MODA EB_GARAMOND ITALIANA FORUM TENOR_SANS GILDA_DISPLAY MARCELLUS
Example
UI_SANS_SERIF
itemDisplay
required

Whether to treat all links as flat web links or try to embed more advanced data.

string
""
Allowed values: FROM_LAYOUT BANNER BANNER_INTELLIGENT
Example
Embedding a tweet
layoutDisplay

Which way to display the list when WinkLinks first loads

string
default: GRID_COLUMNS
Allowed values: LIST GRID_ROWS GRID_COLUMNS GRID_SINGLE_COLUMN
Example
LIST
mobileBackgroundImage

Mobile background image

object
angle

Media angle

string
""
Example
-90
attribution

Whether image has attribution properties

Array<object>
""
object
name
required

Name of contributor

string
"" >= 1 characters
Example
Samuel Adams
url

URL to contributor

string format: uri
""
Example
https://maps.google.com/maps/contrib/111628493169070103594
Example
{
"name": "Samuel Adams",
"url": "https://maps.google.com/maps/contrib/111628493169070103594"
}
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>
""

Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.

object
creator

Whether it was user or system generated.

string
default: USER
Allowed values: SYSTEM USER
Example
SYSTEM
description
required

Longer text description

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

Indicate which language this description is written in.

string
default: en >= 2 characters <= 2 characters /^[a-z]{2}(-[A-Z]{2})?$/
Example
en
md5ContentHash

The md5 hash of the name, description and language.

string
""
Example
d41d8cd98f00b204e9800998ecf8427e
name
required

Use as title or short text description

string
""
Example
An example title
Example
{
"creator": "USER",
"description": "Spacious suite with floor-to-ceiling windows overlooking the Chao Phraya River, featuring a king-size bed, private balcony, and marble bathroom.",
"language": "en",
"md5ContentHash": "a3f1c8e2d74b60912a5c3e9b1d7f4e82",
"name": "Deluxe River View Suite"
}
height
required

Media height in pixels.

integer format: int32
"" >= 1
Example
1600
identifier
required

Use this identifier to communicate with Cloudinary.

string
"" >= 1 characters
Example
cloudinary-image-1
isLandscape

True if media width is greater or equal to height

boolean
Example
true
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
multimediaIdentifier
required

Document identifier

string format: uuid
"" >= 1 characters
Example
3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51
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
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
source
required

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

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

Whether Cloudinary media is a VIDEO or IMAGE.

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

Media width in pixels.

integer format: int32
"" >= 1
Example
2560
Example
{
"angle": null,
"attribution": [],
"category": "2",
"descriptions": [
{
"description": "Elegant lobby of The Siam Residences",
"language": "en",
"title": "Lobby Entrance"
}
],
"height": 1600,
"identifier": "the-siam-residences/lobby-entrance",
"isLandscape": true,
"lifestyleType": null,
"multimediaIdentifier": "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51",
"published": true,
"sort": 10,
"source": "CLOUDINARY",
"type": "IMAGE",
"width": 2560
}
mobileGradientAngle

Mobile gradient angle in degrees (0-360)

integer format: int32
default: 180
Example
180
mobileGradientEnabled

Whether the mobile gradient background is enabled

boolean
Example
false
mobileGradientType

Mobile gradient type

string
default: LINEAR
Allowed values: LINEAR RADIAL
Example
LINEAR
mobilePattern

Mobile background pattern type

string
""
Allowed values: GRID DOT_MATRIX DIAGONAL_LINES GRADIENT_MESH CHECKERBOARD
Example
GRID
onlinePresencePosition

Where to show the online presence icons

string
default: TOP
Allowed values: TOP BOTTOM
Example
BOTTOM
profilePictureGeometry

Controls how to display profile picture

string
default: CIRCLE
Allowed values: CIRCLE RECTANGLE HERO
Example
CIRCLE
profilePictureSize

Profile picture size for circle and rectangle geometries

string
default: MD
Allowed values: SM MD LG
Example
MD
qrCodeOptions

Customizable QR code options

object
backgroundEndColor

Corner square gradient color

string
""
Example
#FFFFFF
backgroundGradientRotation

Corners square gradient rotation

integer format: int32
0
Example
5
backgroundGradientType

Corners square gradient

string
default: LINEAR
Allowed values: LINEAR RADIAL
Example
LINEAR
backgroundRound

Corner square type

integer format: int32
0
Example
0
backgroundStartColor

Corner square primary color

string
""
Example
#000000
cornerDotEndColor

Corner dot gradient color

string
""
Example
#FFFFFF
cornerDotGradientRotation

Corners dot gradient rotation

integer format: int32
0
Example
5
cornerDotGradientType

Corners dot gradient

string
default: LINEAR
Allowed values: LINEAR RADIAL
Example
LINEAR
cornerDotStartColor

Corner dot primary color

string
""
Example
#000000
cornerDotType

Corner dot type

string
default: SQUARE
Allowed values: SQUARE DOT
Example
SQUARE
cornerSquareEndColor

Corner square gradient color

string
""
Example
#FFFFFF
cornerSquareGradientRotation

Corners square gradient rotation

integer format: int32
0
Example
5
cornerSquareGradientType

Corners square gradient

string
default: LINEAR
Allowed values: LINEAR RADIAL
Example
LINEAR
cornerSquareStartColor

Corner square primary color

string
""
Example
#000000
cornerSquareType

Corner square type

string
default: SQUARE
Allowed values: SQUARE EXTRA_ROUNDED DOT
Example
SQUARE
dotsEndColor

Dots gradient color

string
""
Example
#FFFFFF
dotsGradientRotation

Dots gradient rotation

integer format: int32
0
Example
5
dotsGradientType

Dots gradient

string
default: LINEAR
Allowed values: LINEAR RADIAL
Example
LINEAR
dotsRoundSize

Dots round size

boolean
default: true
Example
true
dotsStartColor

Dots primary color

string
""
Example
#000000
dotsType

QR code shape

string
default: SQUARE
Allowed values: DOTS ROUNDED CLASSY CLASSY_ROUNDED SQUARE EXTRA_ROUNDED
Example
SQUARE
imageIdentifier

Custom image ID for subscribers

string
""
Example
abc123
shape

QR code shape

string
default: SQUARE
Allowed values: SQUARE CIRCLE
Example
CIRCLE
Example
{
"backgroundEndColor": "#FFFFFF",
"backgroundGradientRotation": 5,
"backgroundGradientType": "LINEAR",
"backgroundRound": 0,
"backgroundStartColor": "#000000",
"cornerDotEndColor": "#FFFFFF",
"cornerDotGradientRotation": 5,
"cornerDotGradientType": "LINEAR",
"cornerDotStartColor": "#000000",
"cornerDotType": "SQUARE",
"cornerSquareEndColor": "#FFFFFF",
"cornerSquareGradientRotation": 5,
"cornerSquareGradientType": "LINEAR",
"cornerSquareStartColor": "#000000",
"cornerSquareType": "SQUARE",
"dotsEndColor": "#FFFFFF",
"dotsGradientRotation": 5,
"dotsGradientType": "LINEAR",
"dotsRoundSize": true,
"dotsStartColor": "#000000",
"dotsType": "SQUARE",
"imageIdentifier": "abc123",
"shape": "CIRCLE"
}
themeColors

Theme colors are connected with the primary account customization.

object
body

Body color

string
default: #212529
Example
#212529
danger

Danger color

string
default: #dc3545
Example
#dc3545
dark

Dark color

string
default: #343a40
Example
#343a40
info

Info color

string
default: #17a2b8
Example
#17a2b8
light

Light color

string
default: #f8f9fa
Example
#f8f9fa
muted

Muted color

string
default: #6c757d
Example
#6c757d
primary

Primary color

string
default: #dc3545
Example
#dc3545
secondary

Secondary color

string
default: #6c757d
Example
#6c757d
success

Success color

string
default: #28a745
Example
#28a745
warning

Warning color

string
default: #ffc107
Example
#ffc107
white

White color

string
default: #ffffff
Example
#ffffff
Example
{
"body": "#212529",
"danger": "#dc3545",
"dark": "#343a40",
"info": "#17a2b8",
"light": "#f8f9fa",
"muted": "#6c757d",
"primary": "#dc3545",
"secondary": "#6c757d",
"success": "#28a745",
"warning": "#ffc107",
"white": "#ffffff"
}
Example
{
"accountNameSize": "LG",
"customizationIdentifier": "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47",
"desktopBackgroundImage": {
"angle": null,
"attribution": [],
"category": "2",
"descriptions": [
{
"description": "Elegant lobby of The Siam Residences",
"language": "en",
"title": "Lobby Entrance"
}
],
"height": 1600,
"identifier": "the-siam-residences/lobby-entrance",
"isLandscape": true,
"lifestyleType": null,
"multimediaIdentifier": "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51",
"published": true,
"sort": 10,
"source": "CLOUDINARY",
"type": "IMAGE",
"width": 2560
},
"desktopGradientAngle": 180,
"desktopGradientEnabled": false,
"desktopGradientType": "LINEAR",
"desktopPattern": "GRID",
"fontId": "UI_SANS_SERIF",
"itemDisplay": "Embedding a tweet",
"layoutDisplay": "LIST",
"mobileBackgroundImage": {
"angle": null,
"attribution": [],
"category": "2",
"descriptions": [
{
"description": "Elegant lobby of The Siam Residences",
"language": "en",
"title": "Lobby Entrance"
}
],
"height": 1600,
"identifier": "the-siam-residences/lobby-entrance",
"isLandscape": true,
"lifestyleType": null,
"multimediaIdentifier": "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51",
"published": true,
"sort": 10,
"source": "CLOUDINARY",
"type": "IMAGE",
"width": 2560
},
"mobileGradientAngle": 180,
"mobileGradientEnabled": false,
"mobileGradientType": "LINEAR",
"mobilePattern": "GRID",
"onlinePresencePosition": "BOTTOM",
"profilePictureGeometry": "CIRCLE",
"profilePictureSize": "MD",
"qrCodeOptions": {
"backgroundEndColor": "#FFFFFF",
"backgroundGradientRotation": 5,
"backgroundGradientType": "LINEAR",
"backgroundRound": 0,
"backgroundStartColor": "#000000",
"cornerDotEndColor": "#FFFFFF",
"cornerDotGradientRotation": 5,
"cornerDotGradientType": "LINEAR",
"cornerDotStartColor": "#000000",
"cornerDotType": "SQUARE",
"cornerSquareEndColor": "#FFFFFF",
"cornerSquareGradientRotation": 5,
"cornerSquareGradientType": "LINEAR",
"cornerSquareStartColor": "#000000",
"cornerSquareType": "SQUARE",
"dotsEndColor": "#FFFFFF",
"dotsGradientRotation": 5,
"dotsGradientType": "LINEAR",
"dotsRoundSize": true,
"dotsStartColor": "#000000",
"dotsType": "SQUARE",
"imageIdentifier": "abc123",
"shape": "CIRCLE"
},
"themeColors": {
"body": "#212529",
"danger": "#dc3545",
"dark": "#343a40",
"info": "#17a2b8",
"light": "#f8f9fa",
"muted": "#6c757d",
"primary": "#dc3545",
"secondary": "#6c757d",
"success": "#28a745",
"warning": "#ffc107",
"white": "#ffffff"
}
}

Syndication settings saved and returned with resolved theme colors

Media typeapplication/json

WinkLinks display settings enriched with the resolved theme colors from the account’s active customization, used when rendering the public profile page.

object
accountNameSize

Account name heading size

string
default: LG
Allowed values: SM MD LG XL
createdDate

Datetime this record was first created

string | null format: date-time
""
customizationIdentifier
required

Customization identifier

string format: uuid
"" >= 1 characters
desktopBackgroundImage

Desktop background image

object
angle

Media angle

string
""
attribution

Whether image has attribution properties

Array<object>
""
object
name
required

Name of contributor

string
"" >= 1 characters
url

URL to contributor

string format: uri
""
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>
""

Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.

object
creator

Whether it was user or system generated.

string
default: USER
Allowed values: SYSTEM USER
description
required

Longer text description

string
"" >= 1 characters <= 2147483647 characters
hashMismatch
boolean
language
required

Indicate which language this description is written in.

string
default: en >= 2 characters <= 2 characters /^[a-z]{2}(-[A-Z]{2})?$/
md5ContentHash

The md5 hash of the name, description and language.

string
""
name
required

Use as title or short text description

string
""
height
required

Media height in pixels.

integer format: int32
"" >= 1
identifier
required

Use this identifier to communicate with Cloudinary.

string
"" >= 1 characters
isLandscape

True if media width is greater or equal to height

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
multimediaIdentifier
required

Document identifier

string format: uuid
"" >= 1 characters
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
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
source
required

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

string
default: CLOUDINARY
Allowed values: YOUTUBE CLOUDINARY
type
required

Whether Cloudinary media is a VIDEO or IMAGE.

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

Media width in pixels.

integer format: int32
"" >= 1
desktopGradientAngle

Desktop gradient angle in degrees (0-360)

integer format: int32
default: 180
desktopGradientEnabled

Whether the desktop gradient background is enabled

boolean
desktopGradientType

Desktop gradient type

string
default: LINEAR
Allowed values: LINEAR RADIAL
desktopPattern

Desktop background pattern type

string
""
Allowed values: GRID DOT_MATRIX DIAGONAL_LINES GRADIENT_MESH CHECKERBOARD
fontId

Custom font for account name display

string
""
Allowed values: UI_SANS_SERIF UI_SERIF PLAYFAIR_DISPLAY LIBRE_BASKERVILLE CORMORANT_GARAMOND JOSEFIN_SANS RALEWAY LORA SPACE_GROTESK DM_SERIF_DISPLAY OUTFIT CRIMSON_PRO CINZEL BODONI_MODA EB_GARAMOND ITALIANA FORUM TENOR_SANS GILDA_DISPLAY MARCELLUS
id

Unique identifier for this record.

string format: uuid
""
itemDisplay

Whether to treat all links as flat web links or try to embed more advanced data.

string
""
Allowed values: FROM_LAYOUT BANNER BANNER_INTELLIGENT
lastUpdate

Datetime this record was last updated

string | null format: date-time
""
layoutDisplay

Which way to itemDisplay the list when WinkLinks first loads

string
default: GRID_COLUMNS
Allowed values: LIST GRID_ROWS GRID_COLUMNS GRID_SINGLE_COLUMN
mobileBackgroundImage

Mobile background image

object
angle

Media angle

string
""
attribution

Whether image has attribution properties

Array<object>
""
object
name
required

Name of contributor

string
"" >= 1 characters
url

URL to contributor

string format: uri
""
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>
""

Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.

object
creator

Whether it was user or system generated.

string
default: USER
Allowed values: SYSTEM USER
description
required

Longer text description

string
"" >= 1 characters <= 2147483647 characters
hashMismatch
boolean
language
required

Indicate which language this description is written in.

string
default: en >= 2 characters <= 2 characters /^[a-z]{2}(-[A-Z]{2})?$/
md5ContentHash

The md5 hash of the name, description and language.

string
""
name
required

Use as title or short text description

string
""
height
required

Media height in pixels.

integer format: int32
"" >= 1
identifier
required

Use this identifier to communicate with Cloudinary.

string
"" >= 1 characters
isLandscape

True if media width is greater or equal to height

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
multimediaIdentifier
required

Document identifier

string format: uuid
"" >= 1 characters
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
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
source
required

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

string
default: CLOUDINARY
Allowed values: YOUTUBE CLOUDINARY
type
required

Whether Cloudinary media is a VIDEO or IMAGE.

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

Media width in pixels.

integer format: int32
"" >= 1
mobileGradientAngle

Mobile gradient angle in degrees (0-360)

integer format: int32
default: 180
mobileGradientEnabled

Whether the mobile gradient background is enabled

boolean
mobileGradientType

Mobile gradient type

string
default: LINEAR
Allowed values: LINEAR RADIAL
mobilePattern

Mobile background pattern type

string
""
Allowed values: GRID DOT_MATRIX DIAGONAL_LINES GRADIENT_MESH CHECKERBOARD
onlinePresencePosition

Where to show the online presence icons

string
default: TOP
Allowed values: TOP BOTTOM
ownerIdentifier
required

The user’s owner company this entry associates with

string format: uuid
"" >= 1 characters
profilePictureGeometry

Controls how to itemDisplay profile picture

string
default: CIRCLE
Allowed values: CIRCLE RECTANGLE HERO
profilePictureSize

Profile picture size for circle and rectangle geometries

string
default: MD
Allowed values: SM MD LG
qrCodeOptions

Customizable QR code options

object
backgroundEndColor

Corner square gradient color

string
""
backgroundGradientRotation

Corners square gradient rotation

integer format: int32
0
backgroundGradientType

Corners square gradient

string
default: LINEAR
Allowed values: LINEAR RADIAL
backgroundRound

Corner square type

integer format: int32
0
backgroundStartColor

Corner square primary color

string
""
cornerDotEndColor

Corner dot gradient color

string
""
cornerDotGradientRotation

Corners dot gradient rotation

integer format: int32
0
cornerDotGradientType

Corners dot gradient

string
default: LINEAR
Allowed values: LINEAR RADIAL
cornerDotStartColor

Corner dot primary color

string
""
cornerDotType

Corner dot type

string
default: SQUARE
Allowed values: SQUARE DOT
cornerSquareEndColor

Corner square gradient color

string
""
cornerSquareGradientRotation

Corners square gradient rotation

integer format: int32
0
cornerSquareGradientType

Corners square gradient

string
default: LINEAR
Allowed values: LINEAR RADIAL
cornerSquareStartColor

Corner square primary color

string
""
cornerSquareType

Corner square type

string
default: SQUARE
Allowed values: SQUARE EXTRA_ROUNDED DOT
dotsEndColor

Dots gradient color

string
""
dotsGradientRotation

Dots gradient rotation

integer format: int32
0
dotsGradientType

Dots gradient

string
default: LINEAR
Allowed values: LINEAR RADIAL
dotsRoundSize

Dots round size

boolean
default: true
dotsStartColor

Dots primary color

string
""
dotsType

QR code shape

string
default: SQUARE
Allowed values: DOTS ROUNDED CLASSY CLASSY_ROUNDED SQUARE EXTRA_ROUNDED
imageIdentifier

Custom image ID for subscribers

string
""
shape

QR code shape

string
default: SQUARE
Allowed values: SQUARE CIRCLE
themeColors

Theme colors are connected with the primary account customization.

object
body

Body color

string
default: #212529
danger

Danger color

string
default: #dc3545
dark

Dark color

string
default: #343a40
info

Info color

string
default: #17a2b8
light

Light color

string
default: #f8f9fa
muted

Muted color

string
default: #6c757d
primary

Primary color

string
default: #dc3545
secondary

Secondary color

string
default: #6c757d
success

Success color

string
default: #28a745
warning

Warning color

string
default: #ffc107
white

White color

string
default: #ffffff
userIdentifier
required

Creator of entry

string format: uuid
"" >= 1 characters
version

Optimistic-locking version. Echo this value back as an If-Match request header on a conditional update; the server responds 409 if the record changed in the meantime. Null when this projection has no backing versioned document, in which case no conditional update is possible.

integer | null format: int64
""
key
additional properties
""
Example
{
"accountNameSize": "LG",
"createdDate": "2026-01-14T09:30:00",
"customizationIdentifier": "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51",
"desktopBackgroundImage": null,
"desktopGradientAngle": 180,
"desktopGradientEnabled": false,
"desktopGradientType": "LINEAR",
"desktopPattern": "GRID",
"fontId": "UI_SANS_SERIF",
"id": "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47",
"itemDisplay": "FROM_LAYOUT",
"lastUpdate": "2026-02-03T16:45:12",
"layoutDisplay": "GRID_COLUMNS",
"mobileBackgroundImage": null,
"mobileGradientAngle": 180,
"mobileGradientEnabled": false,
"mobileGradientType": "LINEAR",
"mobilePattern": "GRID",
"onlinePresencePosition": "TOP",
"ownerIdentifier": "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69",
"profilePictureGeometry": "CIRCLE",
"profilePictureSize": "MD",
"qrCodeOptions": {
"backgroundEndColor": "#F8F9FA",
"backgroundGradientRotation": 0,
"backgroundGradientType": "LINEAR",
"backgroundRound": 0,
"backgroundStartColor": "#FFFFFF",
"cornerDotEndColor": "#FFFFFF",
"cornerDotGradientRotation": 0,
"cornerDotGradientType": "LINEAR",
"cornerDotStartColor": "#000000",
"cornerDotType": "SQUARE",
"cornerSquareEndColor": "#FFFFFF",
"cornerSquareGradientRotation": 0,
"cornerSquareGradientType": "LINEAR",
"cornerSquareStartColor": "#000000",
"cornerSquareType": "SQUARE",
"dotsEndColor": "#FFFFFF",
"dotsGradientRotation": 0,
"dotsGradientType": "LINEAR",
"dotsRoundSize": true,
"dotsStartColor": "#000000",
"dotsType": "SQUARE",
"imageIdentifier": "abc123",
"shape": "SQUARE"
},
"themeColors": {
"body": "#212529",
"danger": "#dc3545",
"dark": "#343a40",
"info": "#17a2b8",
"light": "#f8f9fa",
"muted": "#6c757d",
"primary": "#dc3545",
"secondary": "#6c757d",
"success": "#28a745",
"warning": "#ffc107",
"white": "#FFFFFF"
},
"userIdentifier": "c3a9f2e1-8b4d-4c7a-a1e2-5f0b6d9e2c84"
}

Bad Request — missing or invalid request parameter or body

Media typeapplication/problem+json
object
detail
string
instance
string format: uri
properties
object
key
additional properties
status
integer format: int32
title
string
type
string format: uri
key
additional properties
""
Example

Unauthorized — authentication is required or the session has expired

Media typeapplication/problem+json
object
detail
string
instance
string format: uri
properties
object
key
additional properties
status
integer format: int32
title
string
type
string format: uri
key
additional properties
""
Example

Forbidden — authenticated but lacking the required permission or scope

Media typeapplication/problem+json
object
detail
string
instance
string format: uri
properties
object
key
additional properties
status
integer format: int32
title
string
type
string format: uri
key
additional properties
""
Example

Not Found — the requested resource does not exist

Media typeapplication/problem+json
object
detail
string
instance
string format: uri
properties
object
key
additional properties
status
integer format: int32
title
string
type
string format: uri
key
additional properties
""
Example

Method Not Allowed — the HTTP verb is not supported on this endpoint

Media typeapplication/problem+json
object
detail
string
instance
string format: uri
properties
object
key
additional properties
status
integer format: int32
title
string
type
string format: uri
key
additional properties
""
Example

Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version

Media typeapplication/problem+json
object
detail
string
instance
string format: uri
properties
object
key
additional properties
status
integer format: int32
title
string
type
string format: uri
key
additional properties
""
Example

Unsupported Media Type — use application/json

Media typeapplication/problem+json
object
detail
string
instance
string format: uri
properties
object
key
additional properties
status
integer format: int32
title
string
type
string format: uri
key
additional properties
""
Example

Internal Server Error — an unexpected failure occurred on the server

Media typeapplication/problem+json
object
detail
string
instance
string format: uri
properties
object
key
additional properties
status
integer format: int32
title
string
type
string format: uri
key
additional properties
""
Example

Service Unavailable — a downstream dependency is unreachable

Media typeapplication/problem+json
object
detail
string
instance
string format: uri
properties
object
key
additional properties
status
integer format: int32
title
string
type
string format: uri
key
additional properties
""
Example