Skip to content

Create

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

Create a new map configuration owned by the specified managing entity with the supplied settings.

managingEntityIdentifier
required
string
""

UUID of the managing entity that will own the map.

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

Map configuration including name, center coordinates, zoom level, style and the list of inventory items to display as markers

Media typeapplication/json

Request to create or update a map configuration for displaying inventory

object
center
required

GeoJSON point defining map center (longitude, latitude)

object
coordinates
Array<number>
type
string
x
number format: double
y
number format: double
Example
{
"coordinates": [
100.5581533,
13.7370197
],
"type": "Point"
}
circles
Array<object>

Optional circular overlay regions on the map

object
point
required

Circle center point

object
coordinates
Array<number>
type
string
x
number format: double
y
number format: double
radius
required

Circle radius from center

number format: double
""
Example
2.5
Example
{
"radius": 2.5
}
customizationIdentifier
required

UUID of the customization context (e.g., Wink Links, channel manager)

string format: uuid
"" >= 1 characters
Example
3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51
displayType
required

Which data to display initially (NATIVE, MODIFIED, or AFFILIATE)

string
default: NATIVE
Allowed values: NATIVE HOTEL ROOM
Example
NATIVE
draggable
required

Allow users to pan the map by dragging

boolean
default: true
Example
true
initialZoomLevel
required

Initial zoom level (0-21, where 0 shows the entire world)

integer format: int32
"" <= 21
Example
15
mapHeight
required

Height of the embedded map in pixels

integer format: int32
"" >= 1
Example
500
mapMarkerColor
required

Hexadecimal color code for map markers

string
""
Allowed values: cc2138
Example
cc2138
mapStyle
required

Map visual style (normal, clean, or bluish)

string
""
Allowed values: normal clean bluish
Example
normal
markers
Array<object>

Optional custom markers to display on the map

object
point
required

A GeoJSON point

object
coordinates
Array<number>
type
string
x
number format: double
y
number format: double
name
required

Display name for this map

string
"" >= 1 characters
Example
Premium Hotels in Southeast Asia
polygons
Array<object>

Optional polygonal overlay regions on the map

object
polygon
required

A GeoJSON polygon

object
coordinates
Array<object>
object
coordinates
Array<object>
object
x
number format: double
y
number format: double
type
string
points
Array<object>
object
x
number format: double
y
number format: double
type
string
rectangles
Array<object>

Optional rectangular overlay regions on the map

object
rectangle
required

A GeoJSON rectangle

object
northEast
required

North-east corner of the geographic bounding rectangle

object
coordinates
Array<number>
type
string
x
number format: double
y
number format: double
southWest
required

South-west corner of the geographic bounding rectangle

object
coordinates
Array<number>
type
string
x
number format: double
y
number format: double
type
required

Category of inventory being displayed (SINGLE, LIST, or SEARCH)

string
""
Allowed values: SINGLE LIST SEARCH
Example
LIST
typeIdentifier
required

UUID of the inventory source: single channel inventory, curated list, or dynamic search

string format: uuid
"" >= 1 characters
Example
7a0c5d9e-2f6b-4c1a-8e4d-3b9f1a0c6d52
zoomable
required

Allow users to zoom in and out

boolean
default: true
Example
true
Example
{
"center": {
"coordinates": [
100.5581533,
13.7370197
],
"type": "Point"
},
"circles": [
{
"radius": 2.5
}
],
"customizationIdentifier": "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51",
"displayType": "NATIVE",
"draggable": true,
"initialZoomLevel": 15,
"mapHeight": 500,
"mapMarkerColor": "cc2138",
"mapStyle": "normal",
"name": "Premium Hotels in Southeast Asia",
"type": "LIST",
"typeIdentifier": "7a0c5d9e-2f6b-4c1a-8e4d-3b9f1a0c6d52",
"zoomable": true
}

Map configuration created successfully

Media typeapplication/json
object
center
required

GeoJSON point defining map center (longitude, latitude)

object
coordinates
Array<number>
type
string
x
number format: double
y
number format: double
circles
Array<object>

Optional circular overlay regions on the map

object
point
required

Circle center point

object
coordinates
Array<number>
type
string
x
number format: double
y
number format: double
radius
required

Circle radius from center

number format: double
""
customizationIdentifier
required

UUID of the customization context (e.g., Wink Links, channel manager)

string format: uuid
"" >= 1 characters
displayType
required

Which data to display initially (NATIVE, MODIFIED, or AFFILIATE)

string
default: NATIVE
Allowed values: NATIVE HOTEL ROOM
draggable
required

Allow users to pan the map by dragging

boolean
default: true
identifier
required

Unique identifier of this map (assigned by server)

string format: uuid
"" >= 1 characters
initialZoomLevel
required

Initial zoom level (0-21, where 0 shows the entire world)

integer format: int32
"" <= 21
mapHeight
required

Height of the embedded map in pixels

integer format: int32
"" >= 1
mapMarkerColor
required

Hexadecimal color code for map markers

string
""
Allowed values: cc2138
mapStyle
required

Map visual style (normal, clean, or bluish)

string
""
Allowed values: normal clean bluish
markers
Array<object>

Optional custom markers to display on the map

object
point
required

A GeoJSON point

object
coordinates
Array<number>
type
string
x
number format: double
y
number format: double
name
required

Display name for this map

string
"" >= 1 characters
ownerIdentifier
required

UUID of the managing entity that owns this map

string format: uuid
"" >= 1 characters
polygons
Array<object>

Optional polygonal overlay regions on the map

object
polygon
required

A GeoJSON polygon

object
coordinates
Array<object>
object
coordinates
Array<object>
object
x
number format: double
y
number format: double
type
string
points
Array<object>
object
x
number format: double
y
number format: double
type
string
rectangles
Array<object>

Optional rectangular overlay regions on the map

object
rectangle
required

A GeoJSON rectangle

object
northEast
required

North-east corner of the geographic bounding rectangle

object
coordinates
Array<number>
type
string
x
number format: double
y
number format: double
southWest
required

South-west corner of the geographic bounding rectangle

object
coordinates
Array<number>
type
string
x
number format: double
y
number format: double
type
required

Category of inventory being displayed (SINGLE, LIST, or SEARCH)

string
""
Allowed values: SINGLE LIST SEARCH
typeIdentifier
required

UUID of the inventory source: single channel inventory, curated list, or dynamic search

string format: uuid
"" >= 1 characters
zoomable
required

Allow users to zoom in and out

boolean
default: true
key
additional properties
""
Example

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