Create shareable supplier link

POST

/api/managing-entity/{managingEntityIdentifier}/studio/shareable-link/supplier

const url = 'https://api.wink.travel/api/managing-entity/d2c8f3a9-4b1e-4c7a-9d3f-5b8a2e6c1d04/studio/shareable-link/supplier';
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/d2c8f3a9-4b1e-4c7a-9d3f-5b8a2e6c1d04/studio/shareable-link/supplier \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Wink-Version: 2.0' \
  --data null

Creates a new shareable supplier link owned by the specified managing entity. The authenticated user is recorded as the creator. The link will be assigned a unique shareable URL identifier.

Authorizations

oauth2ClientCredentials

Parameters

Path Parameters

managingEntityIdentifier

required

string

Managing entity identifier (the owner of the new shareable link)

Example

d2c8f3a9-4b1e-4c7a-9d3f-5b8a2e6c1d04

Header Parameters

Wink-Version

string

default: 2.0.0

Allowed values: 2.0

Request Body^required

application/json

Request to create or update a shareable supplier link with OpenGraph metadata and customization

object

name

required

Display name for this shareable link (internal reference, not shown to end users)

string

"" >= 1 characters

Example

The Siam Residences, Bangkok

customizationIdentifier

required

Customization configuration identifier (controls the visual theme and styling)

string format: uuid

"" >= 1 characters

Example

8f2d4a9c-1e7b-4f3d-a5c8-9d1b6e2c0a47

descriptions

required

Array<object>

>= 1 items <= 2147483647 items

Localized link title and description (one entry per language/locale)

object

name

required

Use as title or short text description

string

Example

An example title

description

required

Longer text description

string

"" >= 1 characters <= 2147483647 characters

Example

This is a longer description in the specified language.

language

required

Indicate which language this description is written in.

string

default: en >= 2 characters <= 2 characters

Example

en

creator

Whether it was user or system generated.

string

default: USER

Allowed values: SYSTEM USER

Example

SYSTEM

md5ContentHash

The md5 hash of the name, description and language.

string

hashMismatch

boolean

multimedias

Array<object>

Hero images to display on the shareable link

object

multimediaIdentifier

required

Document identifier

string format: uuid

"" >= 1 characters

Example

image-1

identifier

required

Use this identifier to communicate with Cloudinary.

string

"" >= 1 characters

Example

cloudinary-image-1

type

required

Whether Cloudinary media is a VIDEO or IMAGE.

string

Allowed values: IMAGE VIDEO AUDIO RAW

Example

IMAGE

source

required

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

string

default: CLOUDINARY

Allowed values: YOUTUBE CLOUDINARY

Example

CLOUDINARY

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

angle

Media angle

string

Example

-90

width

required

Media width in pixels.

integer format: int32

"" >= 1

Example

height

required

Media height in pixels.

integer format: int32

"" >= 1

Example

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

category

Supported OTA specification PIC code. See OTA geoname data

string

Example

descriptions

Localized media captions to give user some context about where this media was taken.

Array<object>

object

name

required

Use as title or short text description

string

Example

An example title

description

required

Longer text description

string

"" >= 1 characters <= 2147483647 characters

Example

This is a longer description in the specified language.

language

required

Indicate which language this description is written in.

string

default: en >= 2 characters <= 2 characters

Example

en

creator

Whether it was user or system generated.

string

default: USER

Allowed values: SYSTEM USER

Example

SYSTEM

md5ContentHash

The md5 hash of the name, description and language.

string

hashMismatch

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

Example

LIFESTYLE_HEALTH_FITNESS

attribution

Whether image has attribution properties

Array<object>

object

url

URL to contributor

string

Example

https://maps.google.com/maps/contrib/111628493169070103594

name

required

Name of contributor

string

"" >= 1 characters

Example

Samuel Adams

isLandscape

True if media width is greater or equal to height

boolean

Example

true

keywords

required

Array<string>

twitterAccount

Twitter account handle for OpenGraph metadata when the link is shared

string

Example

@thesiamresidences

facebookAppId

Facebook App ID for OpenGraph metadata when the link is shared

string

Example

198273987219

theme

Visual theme controlling the appearance of the shareable link banner

string

Allowed values: THEME_1

supplierIdentifier

required

Property or supplier identifier (the entity whose inventory is promoted)

string format: uuid

"" >= 1 characters

Example

7c9a2e5f-3d8b-4a1c-b6e2-8f0d1c4a9b3e

animate

When true, renders selected images as an animated GIF (requires at least 2 images)

boolean

animateDelay

Animation frame delay in milliseconds (-1 = no animation)

integer format: int32

default: -1

Example

Responses

201

Shareable link created successfully

application/json

object

Document UUID

string format: uuid

createdDate

Datetime this record was first created

string format: date-time

lastUpdate

Datetime this record was last updated

string format: date-time

version

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.

integer format: int64

userIdentifier

required

Creator of this shareable link (authenticated user)

string format: uuid

"" >= 1 characters

ownerIdentifier

required

Managing entity (owner) of this shareable link

string format: uuid

"" >= 1 characters

name

required

Display name for this shareable link (internal reference, not shown to end users)

string

"" >= 1 characters

customizationIdentifier

required

Customization configuration identifier (controls the visual theme and styling)

string format: uuid

"" >= 1 characters

descriptions

required

Array<object>

>= 1 items <= 2147483647 items

Localized link title and description (one entry per language/locale)

object

name

required

Use as title or short text description

string

description

required

Longer text description

string

"" >= 1 characters <= 2147483647 characters

language

required

Indicate which language this description is written in.

string

default: en >= 2 characters <= 2 characters

creator

Whether it was user or system generated.

string

default: USER

Allowed values: SYSTEM USER

md5ContentHash

The md5 hash of the name, description and language.

string

hashMismatch

boolean

multimedias

Array<object>

Image entries

object

multimediaIdentifier

required

Document identifier

string format: uuid

"" >= 1 characters

identifier

required

Use this identifier to communicate with Cloudinary.

string

"" >= 1 characters

type

required

Whether Cloudinary media is a VIDEO or IMAGE.

string

Allowed values: IMAGE VIDEO AUDIO RAW

source

required

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

string

default: CLOUDINARY

Allowed values: YOUTUBE CLOUDINARY

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

angle

Media angle

string

width

required

Media width in pixels.

integer format: int32

"" >= 1

height

required

Media height in pixels.

integer format: int32

"" >= 1

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

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>

object

name

required

Use as title or short text description

string

description

required

Longer text description

string

"" >= 1 characters <= 2147483647 characters

language

required

Indicate which language this description is written in.

string

default: en >= 2 characters <= 2 characters

creator

Whether it was user or system generated.

string

default: USER

Allowed values: SYSTEM USER

md5ContentHash

The md5 hash of the name, description and language.

string

hashMismatch

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

attribution

Whether image has attribution properties

Array<object>

object

url

URL to contributor

string

name

required

Name of contributor

string

"" >= 1 characters

isLandscape

True if media width is greater or equal to height

boolean

keywords

Array<string>

uniqueId

required

Unique identifier that generates the shareable URL slug (e.g., share.wink.travel/HBDG87f2)

string

"" >= 1 characters

twitterAccount

Twitter account handle for OpenGraph metadata when the link is shared

string

facebookAppId

Facebook App ID for OpenGraph metadata when the link is shared

string

theme

Visual theme controlling the appearance of the shareable link banner

string

Allowed values: THEME_1

status

required

Current status of the shareable link (ACTIVE, INACTIVE, ARCHIVED, etc.)

string

Allowed values: ACTIVE INACTIVE REMOVED

supplierIdentifier

required

Property or supplier identifier (the entity whose inventory is promoted)

string format: uuid

"" >= 1 characters

animate

When true, renders selected images as an animated GIF (requires at least 2 images)

boolean

animateDelay

Animation frame delay in milliseconds (-1 = no animation)

integer format: int32

default: -1

key

additional properties

Example

400

Invalid request body (missing required fields or validation errors)

object

type

string format: uri

title

string

status

integer format: int32

detail

string

instance

string format: uri

properties

object

key

additional properties

Example ^generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "https://example.com",
  "properties": {
    "additionalProperty": "example"
  }
}

401

Authentication required

*/*

object

type

string format: uri

title

string

status

integer format: int32

detail

string

instance

string format: uri

properties

object

key

additional properties

403

User lacks MARKETING:WRITE permission for the managing entity

*/*

object

type

string format: uri

title

string

status

integer format: int32

detail

string

instance

string format: uri

properties

object

key

additional properties

500

Internal Server Error

object

Example ^generated

{}

Create shareable supplier link

Authorizations

Parameters

Path Parameters

Example

Header Parameters

Request Body required

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Responses

201

Example

400

Example generated

401

403

500

Example generated

Request Body^required

Example ^generated

Example ^generated