Create
const url = 'https://api.wink.travel/api/managing-entity/d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69/studio/ranked-grids';const options = { method: 'POST', headers: { 'Wink-Version': '2.0', Authorization: 'Bearer <token>', 'Content-Type': 'application/json' }, body: '{"animate":false,"animateDelay":500,"customizationIdentifier":"7d2e4f1a-6c8b-4a9e-b3d5-1e7f2a0c5b8d","descriptions":[{"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"}],"displayType":"NATIVE","keywords":["luxury"],"lookup":{"cityName":"Bangkok","countryCode":"TH","countryName":"Thailand","id":"b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47","languageCode":"en","location":{"coordinates":[100.5581533,13.7370197],"type":"Point"},"name":"The Siam Residences","ownerName":"The Siam Residences","subCountryName":"Bangkok","subSubCountryName":"Khlong San District","type":"HOTEL","typeIdentifier":"a1f3c9d2-7e4b-4a0c-8d5e-2b9f1a6c3e78","urlName":"the-siam-residences-bangkok-thailand"},"name":"Featured Luxury Resorts Bangkok","sort":"MEMBER"}'};
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/d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69/studio/ranked-grids \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --header 'Wink-Version: 2.0' \ --data '{ "animate": false, "animateDelay": 500, "customizationIdentifier": "7d2e4f1a-6c8b-4a9e-b3d5-1e7f2a0c5b8d", "descriptions": [ { "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" } ], "displayType": "NATIVE", "keywords": [ "luxury" ], "lookup": { "cityName": "Bangkok", "countryCode": "TH", "countryName": "Thailand", "id": "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "languageCode": "en", "location": { "coordinates": [ 100.5581533, 13.7370197 ], "type": "Point" }, "name": "The Siam Residences", "ownerName": "The Siam Residences", "subCountryName": "Bangkok", "subSubCountryName": "Khlong San District", "type": "HOTEL", "typeIdentifier": "a1f3c9d2-7e4b-4a0c-8d5e-2b9f1a6c3e78", "urlName": "the-siam-residences-bangkok-thailand" }, "name": "Featured Luxury Resorts Bangkok", "sort": "MEMBER" }'Persists a new ranked grid for the managing entity and returns the created record. Requires MARKETING:WRITE permission.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Managing entity identifier
Example
d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69Header Parameters
Section titled “Header Parameters”Request Bodyrequired
Section titled “Request Bodyrequired”Ranked grid definition including name, score type, geographic region, and display configuration
object
Create an animated gif instead of a list of images
Example
falseControls animation delay in milliseconds; -1 to disable
Example
500Customization identifier
Example
7d2e4f1a-6c8b-4a9e-b3d5-1e7f2a0c5b8dContains custom title and description of grid
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Whether it was user or system generated.
Example
SYSTEMLonger text description
Example
This is a longer description in the specified language.Indicate which language this description is written in.
Example
enThe md5 hash of the name, description and language.
Example
d41d8cd98f00b204e9800998ecf8427eUse as title or short text description
Example
An example titleExample
{ "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"}Indicate which initial values to display first on the front-facing card
Example
NATIVEThe destination to display ranked inventory from.
object
Name of the closest city where this lookup entry is located
Example
BangkokISO 3166-1 alpha-2 country code
Example
THCountry name where this lookup entry is located
Example
ThailandDatetime this record was first created
Example
2026-01-14T09:30:00Unique identifier for this record.
Example
b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47Language code for the lookup name (ISO 639-1 format)
Example
enDatetime this record was last updated
Example
2026-02-03T16:45:12Geo-location
object
Example
{ "coordinates": [ 100.5581533, 13.7370197 ], "type": "POINT"}Lowercase version of the name, used for regex-based search operations. Extranet surfaces only.
Example
bangkokHuman-readable name of the lookup entry
Example
BangkokWhether this is the primary/original lookup entry for this resource (true) or a variant like an alternate language or name (false). Extranet surfaces only.
Example
trueIdentifier of the owner (supplier) that created or manages this lookup entry. Extranet surfaces only — not serialized on public or partner endpoints.
Example
e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18Name of the owner (supplier) that created this lookup entry
Example
The Siam Residences, BangkokType of owner that created this lookup (TRAVELIKO for platform-managed entries, HOTEL for supplier-created entries). Extranet surfaces only.
Example
TRAVELIKOPlatform-specific sort order (lower values sort first: CITY=1, ISLAND=2, HOTEL=3, others vary). Extranet surfaces only.
Example
1State or province where this lookup entry is located
Example
BangkokCounty or district where this lookup entry is located
Example
Khlong San DistrictType of lookup (CITY, HOTEL, ACTIVITY, SPA, RESTAURANT, ATTRACTION, ISLAND, COUNTRY, PLACE, MEETING_ROOM)
Example
CITYUnique identifier for the lookup type resource (e.g., hotel ID, city geoname ID)
Example
1609350URL-friendly slug that uniquely identifies this lookup within its type and location
Example
bangkok-thailandOptimistic-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.
Example
3Example
{ "cityName": "Bangkok", "countryCode": "TH", "countryName": "Thailand", "id": "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "languageCode": "en", "location": { "coordinates": [ 100.5581533, 13.7370197 ], "type": "Point" }, "name": "The Siam Residences", "ownerName": "The Siam Residences", "subCountryName": "Bangkok", "subSubCountryName": "Khlong San District", "type": "HOTEL", "typeIdentifier": "a1f3c9d2-7e4b-4a0c-8d5e-2b9f1a6c3e78", "urlName": "the-siam-residences-bangkok-thailand"}Descriptive name of this list for seller use only
Example
Featured Luxury Resorts BangkokDetermines which badge to show on the Web Component. Is also used to sort properties for search grids.
Example
MEMBERExample
{ "animate": false, "animateDelay": 500, "customizationIdentifier": "7d2e4f1a-6c8b-4a9e-b3d5-1e7f2a0c5b8d", "descriptions": [ { "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" } ], "displayType": "NATIVE", "keywords": [ "luxury" ], "lookup": { "cityName": "Bangkok", "countryCode": "TH", "countryName": "Thailand", "id": "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "languageCode": "en", "location": { "coordinates": [ 100.5581533, 13.7370197 ], "type": "Point" }, "name": "The Siam Residences", "ownerName": "The Siam Residences", "subCountryName": "Bangkok", "subSubCountryName": "Khlong San District", "type": "HOTEL", "typeIdentifier": "a1f3c9d2-7e4b-4a0c-8d5e-2b9f1a6c3e78", "urlName": "the-siam-residences-bangkok-thailand" }, "name": "Featured Luxury Resorts Bangkok", "sort": "MEMBER"}Responses
Section titled “Responses”Ranked grid successfully created and persisted
Lightweight projection of a ranked sellable list used in listings and event payloads, containing all display and configuration fields without audit metadata
object
Create an animated gif instead of a list of images
Controls animation delay in milliseconds; -1 to disable
Datetime this record was first created
Customization identifier
Contains custom title and description of grid
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Whether it was user or system generated.
Longer text description
Indicate which language this description is written in.
The md5 hash of the name, description and language.
Use as title or short text description
Indicate which initial values to display first on the front-facing card
Unique identifier for this record.
Datetime this record was last updated
The destination to display ranked inventory from.
object
Name of the closest city where this lookup entry is located
ISO 3166-1 alpha-2 country code
Country name where this lookup entry is located
Datetime this record was first created
Unique identifier for this record.
Language code for the lookup name (ISO 639-1 format)
Datetime this record was last updated
Geo-location
object
Lowercase version of the name, used for regex-based search operations. Extranet surfaces only.
Human-readable name of the lookup entry
Whether this is the primary/original lookup entry for this resource (true) or a variant like an alternate language or name (false). Extranet surfaces only.
Identifier of the owner (supplier) that created or manages this lookup entry. Extranet surfaces only — not serialized on public or partner endpoints.
Name of the owner (supplier) that created this lookup entry
Type of owner that created this lookup (TRAVELIKO for platform-managed entries, HOTEL for supplier-created entries). Extranet surfaces only.
Platform-specific sort order (lower values sort first: CITY=1, ISLAND=2, HOTEL=3, others vary). Extranet surfaces only.
State or province where this lookup entry is located
County or district where this lookup entry is located
Type of lookup (CITY, HOTEL, ACTIVITY, SPA, RESTAURANT, ATTRACTION, ISLAND, COUNTRY, PLACE, MEETING_ROOM)
Unique identifier for the lookup type resource (e.g., hotel ID, city geoname ID)
URL-friendly slug that uniquely identifies this lookup within its type and location
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.
Descriptive name of this list for seller use only
AffiliateAccount identifier
Determines which badge to show on the Web Component. Is also used to sort properties for search grids.
Status
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.
Example
Bad Request — missing or invalid request parameter or body
object
object
Example
Unauthorized — authentication is required or the session has expired
object
object
Example
Forbidden — authenticated but lacking the required permission or scope
object
object
Example
Not Found — the requested resource does not exist
object
object
Example
Method Not Allowed — the HTTP verb is not supported on this endpoint
object
object
Example
Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version
object
object
Example
Unsupported Media Type — use application/json
object
object
Example
Internal Server Error — an unexpected failure occurred on the server
object
object
Example
Service Unavailable — a downstream dependency is unreachable