{ "openapi" : "3.1.0", "info" : { "title" : "Wink API", "description" : "Welcome to the Wink API — a programmer-friendly way to manage, sell and book travel\ninventory on the Wink platform. See the **Overview** page (under **API**) for the full\nintroduction, intended audience, testing, and versioning.\n# Link Manager API\nEndpoints for managing WinkLinks pages and shortened URLs: create and organize\nsyndicated inventory entries, tag them with categories, configure syndication settings,\nand manage shortened URL slugs.\n\n", "contact" : { "name" : "Contact", "email" : "hi@wink.travel" }, "version" : "0.0.0-TEST", "x-logo" : { "backgroundColor" : "#FFFFFF", "altText" : "wink", "url" : "https://res.cloudinary.com/traveliko/image/upload/c_scale,h_129/v1653285543/wink/logo_text_white.svg" } }, "externalDocs" : { "description" : "Documentation", "url" : "https://wink.travel/getting-started/how-to-use/" }, "servers" : [ { "url" : "https://api.wink.travel", "description" : "Endpoint" } ], "tags" : [ { "name" : "Shortened URL", "description" : "Create, read, update, and delete shortened URLs with custom slugs for properties, bookings, and external links. Includes Open Graph metadata scraping for external URLs.", "externalDocs" : { "description" : "Try it in Scalar", "url" : "https://api.wink.travel/scalar#link-manager/tag/shortened-url" } }, { "name" : "Design", "description" : "Customize the design and appearance of your WinkLinks page.", "externalDocs" : { "description" : "Try it in Scalar", "url" : "https://api.wink.travel/scalar#link-manager/tag/design" } }, { "name" : "Tags", "description" : "Tag WinkLinks entries with categories so your users can filter your content.", "externalDocs" : { "description" : "Try it in Scalar", "url" : "https://api.wink.travel/scalar#link-manager/tag/tags" } }, { "name" : "Entries", "description" : "Manage your WinkLinks entries.", "externalDocs" : { "description" : "Try it in Scalar", "url" : "https://api.wink.travel/scalar#link-manager/tag/entries" } } ], "paths" : { "/api/managing-entity/{managingEntityIdentifier}/wink-links/syndication/settings" : { "get" : { "tags" : [ "Design" ], "summary" : "Show", "description" : "Load the account's WinkLinks syndication settings along with its resolved theme colors.", "operationId" : "show-syndication-settings", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "Load settings for this managing entity identifier.", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } }, { "name" : "Accept", "in" : "header", "schema" : { "type" : "string", "enum" : [ "application/json" ], "default" : null } } ], "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Syndication settings with resolved theme colors", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SyndicationSettingsWithThemeColors_ManagingEntity" }, "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" } } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] }, "put" : { "tags" : [ "Design" ], "summary" : "Upsert", "description" : "Create or replace the account's WinkLinks syndication settings.", "operationId" : "upsert-syndication-settings", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "Update settings for this managing entity identifier.", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } } ], "requestBody" : { "description" : "WinkLinks settings to create or update", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UpsertSyndicationSettings_ManagingEntity" } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Syndication settings saved and returned with resolved theme colors", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SyndicationSettingsWithThemeColors_ManagingEntity" }, "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" } } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] } }, "/api/managing-entity/{managingEntityIdentifier}/wink-links/syndication/entry/{syndicatedItemIdentifier}" : { "get" : { "tags" : [ "Entries" ], "summary" : "Show one", "description" : "Loads a single WinkLinks entry by its identifier.", "operationId" : "show-syndication-entry", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "Syndication entry owned by this managing entity identifier.", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "syndicatedItemIdentifier", "in" : "path", "description" : "Syndication entry identifier.", "required" : true, "schema" : { "type" : "string" }, "example" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } }, { "name" : "Accept", "in" : "header", "schema" : { "type" : "string", "enum" : [ "application/json" ], "default" : null } } ], "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "The requested WinkLinks entry", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SyndicatedItemLightweight_ManagingEntity" }, "example" : { "contentUrl" : "https://www.google.com", "createdDate" : "2026-01-14T09:30:00", "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" } ], "disabled" : false, "display" : "Embedding a tweet", "hashTags" : [ "#TravelSolo" ], "id" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "lastUpdate" : "2026-02-03T16:45:12", "lockCode" : "ABC123", "multimedias" : "For web links, it would be the Open Graph image url. For a file upload, it would be the multipart file.", "ownerIdentifier" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "publishDate" : "2026-01-15T10:30:00Z", "publishStatus" : "PUBLISHED", "sort" : 0, "status" : "ACTIVE", "tags" : [ { "label" : "Hotel & Resort", "value" : "HOTEL" } ], "title" : "Google", "type" : "WEB_LINK", "uniqueId" : "https://trvl.as/Hbgt56", "userIdentifier" : "c3a9f2e1-8b4d-4c7a-a1e2-5f0b6d9e2c84", "userTags" : [ "@maniot" ], "version" : 3 } } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] }, "put" : { "tags" : [ "Entries" ], "summary" : "Update", "description" : "Replaces an existing WinkLinks entry's content by its identifier.", "operationId" : "update-syndication-entry", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "Update entry for this managing entity identifier.", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "syndicatedItemIdentifier", "in" : "path", "description" : "Syndication entry identifier.", "required" : true, "schema" : { "type" : "string" }, "example" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } } ], "requestBody" : { "description" : "Updated WinkLinks entry", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UpsertSyndicatedItem_ManagingEntity" } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "WinkLinks entry updated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SyndicatedItemLightweight_ManagingEntity" }, "example" : { "contentUrl" : "https://www.google.com", "createdDate" : "2026-01-14T09:30:00", "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" } ], "disabled" : false, "display" : "Embedding a tweet", "hashTags" : [ "#TravelSolo" ], "id" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "lastUpdate" : "2026-02-03T16:45:12", "lockCode" : "ABC123", "multimedias" : "For web links, it would be the Open Graph image url. For a file upload, it would be the multipart file.", "ownerIdentifier" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "publishDate" : "2026-01-15T10:30:00Z", "publishStatus" : "PUBLISHED", "sort" : 0, "status" : "ACTIVE", "tags" : [ { "label" : "Hotel & Resort", "value" : "HOTEL" } ], "title" : "Google", "type" : "WEB_LINK", "uniqueId" : "https://trvl.as/Hbgt56", "userIdentifier" : "c3a9f2e1-8b4d-4c7a-a1e2-5f0b6d9e2c84", "userTags" : [ "@maniot" ], "version" : 3 } } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] }, "delete" : { "tags" : [ "Entries" ], "summary" : "Delete", "description" : "Permanently removes a WinkLinks entry by its identifier.", "operationId" : "remove-syndication-entry", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "Syndication entry owned by this managing entity identifier.", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "syndicatedItemIdentifier", "in" : "path", "description" : "Syndication entry identifier.", "required" : true, "schema" : { "type" : "string" }, "example" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } }, { "name" : "Accept", "in" : "header", "schema" : { "type" : "string", "enum" : [ "application/json" ], "default" : null } } ], "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "WinkLinks entry deleted and returned", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SyndicatedItemLightweight_ManagingEntity" }, "example" : { "contentUrl" : "https://www.google.com", "createdDate" : "2026-01-14T09:30:00", "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" } ], "disabled" : false, "display" : "Embedding a tweet", "hashTags" : [ "#TravelSolo" ], "id" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "lastUpdate" : "2026-02-03T16:45:12", "lockCode" : "ABC123", "multimedias" : "For web links, it would be the Open Graph image url. For a file upload, it would be the multipart file.", "ownerIdentifier" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "publishDate" : "2026-01-15T10:30:00Z", "publishStatus" : "PUBLISHED", "sort" : 0, "status" : "ACTIVE", "tags" : [ { "label" : "Hotel & Resort", "value" : "HOTEL" } ], "title" : "Google", "type" : "WEB_LINK", "uniqueId" : "https://trvl.as/Hbgt56", "userIdentifier" : "c3a9f2e1-8b4d-4c7a-a1e2-5f0b6d9e2c84", "userTags" : [ "@maniot" ], "version" : 3 } } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] } }, "/api/managing-entity/{managingEntityIdentifier}/wink-links/syndication/category/{syndicationCategoryIdentifier}" : { "get" : { "tags" : [ "Tags" ], "summary" : "Show", "description" : "Returns a single syndication category by its identifier within the managing entity.", "operationId" : "show-syndication-category", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "Syndication category owned by this managing entity identifier.", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "syndicationCategoryIdentifier", "in" : "path", "description" : "Syndication category identifier.", "required" : true, "schema" : { "type" : "string" }, "example" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } }, { "name" : "Accept", "in" : "header", "schema" : { "type" : "string", "enum" : [ "application/json" ], "default" : null } } ], "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "The requested syndication category", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SyndicationCategoryLightweight_ManagingEntity" }, "example" : { "createdDate" : "2026-01-14T09:30:00", "id" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "lastUpdate" : "2026-02-03T16:45:12", "name" : "Faves", "ownerIdentifier" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "userIdentifier" : "c3a9f2e1-8b4d-4c7a-a1e2-5f0b6d9e2c84", "version" : 3 } } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] }, "put" : { "tags" : [ "Tags" ], "summary" : "Update", "description" : "Updates an existing syndication category identified by its identifier and returns the updated record.", "operationId" : "update-syndication-category", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "Update category for this managing entity identifier.", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "syndicationCategoryIdentifier", "in" : "path", "description" : "Syndication category identifier.", "required" : true, "schema" : { "type" : "string" }, "example" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } } ], "requestBody" : { "description" : "Updated category", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UpsertSyndicationCategory_ManagingEntity" } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Syndication category updated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SyndicationCategoryLightweight_ManagingEntity" }, "example" : { "createdDate" : "2026-01-14T09:30:00", "id" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "lastUpdate" : "2026-02-03T16:45:12", "name" : "Faves", "ownerIdentifier" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "userIdentifier" : "c3a9f2e1-8b4d-4c7a-a1e2-5f0b6d9e2c84", "version" : 3 } } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] }, "delete" : { "tags" : [ "Tags" ], "summary" : "Delete", "description" : "Removes the syndication category identified by its identifier from the managing entity.", "operationId" : "remove-syndication-category", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "Syndication category owned by this managing entity identifier.", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "syndicationCategoryIdentifier", "in" : "path", "description" : "Syndication category identifier.", "required" : true, "schema" : { "type" : "string" }, "example" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } }, { "name" : "Accept", "in" : "header", "schema" : { "type" : "string", "enum" : [ "application/json" ], "default" : null } } ], "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Syndication category deleted and returned", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SyndicationCategoryLightweight_ManagingEntity" }, "example" : { "createdDate" : "2026-01-14T09:30:00", "id" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "lastUpdate" : "2026-02-03T16:45:12", "name" : "Faves", "ownerIdentifier" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "userIdentifier" : "c3a9f2e1-8b4d-4c7a-a1e2-5f0b6d9e2c84", "version" : 3 } } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] } }, "/api/managing-entity/{managingEntityIdentifier}/wink-links/shortened-url/{shortenedUrlIdentifier}" : { "get" : { "tags" : [ "Shortened URL" ], "summary" : "Show one", "description" : "Loads a single shortened URL by its identifier.", "operationId" : "show-shortened-url", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "Managing entity identifier that owns the shortened URL", "required" : true, "schema" : { "type" : "string", "format" : "uuid" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "shortenedUrlIdentifier", "in" : "path", "description" : "Identifier of the shortened URL to retrieve", "required" : true, "schema" : { "type" : "string", "format" : "uuid" }, "example" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } }, { "name" : "Accept", "in" : "header", "schema" : { "type" : "string", "enum" : [ "application/json" ], "default" : null } } ], "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "The requested shortened URL", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ShortenedUrlLightweight_ManagingEntity" }, "example" : { "audioList" : [ { "alt" : "The Siam Residences exterior view", "height" : "630", "secureUrl" : "https://res.cloudinary.com/traveliko/image/upload/v1689655191/the-siam-residences-bangkok.jpg", "type" : "image/jpeg", "url" : "https://res.cloudinary.com/traveliko/image/upload/v1689655191/the-siam-residences-bangkok.jpg", "width" : "1200" } ], "createdDate" : "2026-01-14T09:30:00", "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" } ], "id" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "imageList" : [ { "alt" : "The Siam Residences exterior view", "height" : "630", "secureUrl" : "https://res.cloudinary.com/traveliko/image/upload/v1689655191/the-siam-residences-bangkok.jpg", "type" : "image/jpeg", "url" : "https://res.cloudinary.com/traveliko/image/upload/v1689655191/the-siam-residences-bangkok.jpg", "width" : "1200" } ], "lastUpdate" : "2026-02-03T16:45:12", "multimedias" : [ { "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 } ], "version" : 3, "videoList" : [ { "alt" : "The Siam Residences exterior view", "height" : "630", "secureUrl" : "https://res.cloudinary.com/traveliko/image/upload/v1689655191/the-siam-residences-bangkok.jpg", "type" : "image/jpeg", "url" : "https://res.cloudinary.com/traveliko/image/upload/v1689655191/the-siam-residences-bangkok.jpg", "width" : "1200" } ] } } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] }, "put" : { "tags" : [ "Shortened URL" ], "summary" : "Update", "description" : "Edits an existing shortened URL's slug and target by its identifier.", "operationId" : "update-shortened-url", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "Managing entity identifier that owns the shortened URL", "required" : true, "schema" : { "type" : "string", "format" : "uuid" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "shortenedUrlIdentifier", "in" : "path", "description" : "Identifier of the shortened URL to update", "required" : true, "schema" : { "type" : "string", "format" : "uuid" }, "example" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } } ], "requestBody" : { "description" : "Updated shortened URL details (title, slug, target, metadata)", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UpsertShortenedUrl_ManagingEntity" } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "The shortened URL after applying the requested changes", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ShortenedUrlLightweight_ManagingEntity" }, "example" : { "audioList" : [ { "alt" : "The Siam Residences exterior view", "height" : "630", "secureUrl" : "https://res.cloudinary.com/traveliko/image/upload/v1689655191/the-siam-residences-bangkok.jpg", "type" : "image/jpeg", "url" : "https://res.cloudinary.com/traveliko/image/upload/v1689655191/the-siam-residences-bangkok.jpg", "width" : "1200" } ], "createdDate" : "2026-01-14T09:30:00", "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" } ], "id" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "imageList" : [ { "alt" : "The Siam Residences exterior view", "height" : "630", "secureUrl" : "https://res.cloudinary.com/traveliko/image/upload/v1689655191/the-siam-residences-bangkok.jpg", "type" : "image/jpeg", "url" : "https://res.cloudinary.com/traveliko/image/upload/v1689655191/the-siam-residences-bangkok.jpg", "width" : "1200" } ], "lastUpdate" : "2026-02-03T16:45:12", "multimedias" : [ { "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 } ], "version" : 3, "videoList" : [ { "alt" : "The Siam Residences exterior view", "height" : "630", "secureUrl" : "https://res.cloudinary.com/traveliko/image/upload/v1689655191/the-siam-residences-bangkok.jpg", "type" : "image/jpeg", "url" : "https://res.cloudinary.com/traveliko/image/upload/v1689655191/the-siam-residences-bangkok.jpg", "width" : "1200" } ] } } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] }, "delete" : { "tags" : [ "Shortened URL" ], "summary" : "Delete", "description" : "Permanently removes a shortened URL by its identifier.", "operationId" : "remove-shortened-url", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "Managing entity identifier that owns the shortened URL", "required" : true, "schema" : { "type" : "string", "format" : "uuid" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "shortenedUrlIdentifier", "in" : "path", "description" : "Identifier of the shortened URL to delete", "required" : true, "schema" : { "type" : "string", "format" : "uuid" }, "example" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } }, { "name" : "Accept", "in" : "header", "schema" : { "type" : "string", "enum" : [ "application/json" ], "default" : null } } ], "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "The shortened URL that was removed", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ShortenedUrlLightweight_ManagingEntity" }, "example" : { "audioList" : [ { "alt" : "The Siam Residences exterior view", "height" : "630", "secureUrl" : "https://res.cloudinary.com/traveliko/image/upload/v1689655191/the-siam-residences-bangkok.jpg", "type" : "image/jpeg", "url" : "https://res.cloudinary.com/traveliko/image/upload/v1689655191/the-siam-residences-bangkok.jpg", "width" : "1200" } ], "createdDate" : "2026-01-14T09:30:00", "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" } ], "id" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "imageList" : [ { "alt" : "The Siam Residences exterior view", "height" : "630", "secureUrl" : "https://res.cloudinary.com/traveliko/image/upload/v1689655191/the-siam-residences-bangkok.jpg", "type" : "image/jpeg", "url" : "https://res.cloudinary.com/traveliko/image/upload/v1689655191/the-siam-residences-bangkok.jpg", "width" : "1200" } ], "lastUpdate" : "2026-02-03T16:45:12", "multimedias" : [ { "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 } ], "version" : 3, "videoList" : [ { "alt" : "The Siam Residences exterior view", "height" : "630", "secureUrl" : "https://res.cloudinary.com/traveliko/image/upload/v1689655191/the-siam-residences-bangkok.jpg", "type" : "image/jpeg", "url" : "https://res.cloudinary.com/traveliko/image/upload/v1689655191/the-siam-residences-bangkok.jpg", "width" : "1200" } ] } } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] } }, "/api/managing-entity/{managingEntityIdentifier}/wink-links/syndication/entry/list" : { "get" : { "tags" : [ "Entries" ], "summary" : "Show all", "description" : "Lists the account's WinkLinks entries, optionally filtered by publication status.", "operationId" : "show-syndication-entry-list", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "List syndication entries owned by this managing entity identifier.", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "status", "in" : "query", "description" : "Filter entries by publication status.", "required" : false, "schema" : { "type" : "string", "default" : "PUBLISHED", "description" : "Publication lifecycle status of a syndicated item, determining whether it is visible on the WinkLinks profile page.", "enum" : [ "PUBLISHED", "ARCHIVED" ] }, "example" : "PUBLISHED" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } }, { "name" : "Accept", "in" : "header", "schema" : { "type" : "string", "enum" : [ "application/json" ], "default" : null } } ], "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "List of WinkLinks entries for the account", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SyndicatedItemLightweight_ManagingEntity" } }, "example" : [ { "contentUrl" : "https://www.google.com", "createdDate" : "2026-01-14T09:30:00", "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" } ], "disabled" : false, "display" : "Embedding a tweet", "hashTags" : [ "#TravelSolo" ], "id" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "lastUpdate" : "2026-02-03T16:45:12", "lockCode" : "ABC123", "multimedias" : "For web links, it would be the Open Graph image url. For a file upload, it would be the multipart file.", "ownerIdentifier" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "publishDate" : "2026-01-15T10:30:00Z", "publishStatus" : "PUBLISHED", "sort" : 0, "status" : "ACTIVE", "tags" : [ { "label" : "Hotel & Resort", "value" : "HOTEL" } ], "title" : "Google", "type" : "WEB_LINK", "uniqueId" : "https://trvl.as/Hbgt56", "userIdentifier" : "c3a9f2e1-8b4d-4c7a-a1e2-5f0b6d9e2c84", "userTags" : [ "@maniot" ], "version" : 3 } ] } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] } }, "/api/managing-entity/{managingEntityIdentifier}/wink-links/syndication/category/list" : { "get" : { "tags" : [ "Tags" ], "summary" : "List", "description" : "Returns all syndication categories owned by the managing entity, used to tag and filter WinkLinks content.", "operationId" : "show-syndication-category-list", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "List syndication categories owned by this managing entity identifier.", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } }, { "name" : "Accept", "in" : "header", "schema" : { "type" : "string", "enum" : [ "application/json" ], "default" : null } } ], "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "List of syndication categories", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SyndicationCategoryLightweight_ManagingEntity" } }, "example" : [ { "createdDate" : "2026-01-14T09:30:00", "id" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "lastUpdate" : "2026-02-03T16:45:12", "name" : "Faves", "ownerIdentifier" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "userIdentifier" : "c3a9f2e1-8b4d-4c7a-a1e2-5f0b6d9e2c84", "version" : 3 } ] } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] } }, "/api/managing-entity/{managingEntityIdentifier}/wink-links/shortened-url/list" : { "get" : { "tags" : [ "Shortened URL" ], "summary" : "Show all", "description" : "Lists every shortened URL owned by the managing entity.", "operationId" : "show-shortened-url-list", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "Managing entity identifier to list shortened URLs for", "required" : true, "schema" : { "type" : "string", "format" : "uuid" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } }, { "name" : "Accept", "in" : "header", "schema" : { "type" : "string", "enum" : [ "application/json" ], "default" : null } } ], "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "List of all shortened URLs belonging to the managing entity", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ShortenedUrlLightweight_ManagingEntity" } }, "example" : [ { "audioList" : [ { "alt" : "The Siam Residences exterior view", "height" : "630", "secureUrl" : "https://res.cloudinary.com/traveliko/image/upload/v1689655191/the-siam-residences-bangkok.jpg", "type" : "image/jpeg", "url" : "https://res.cloudinary.com/traveliko/image/upload/v1689655191/the-siam-residences-bangkok.jpg", "width" : "1200" } ], "createdDate" : "2026-01-14T09:30:00", "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" } ], "id" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "imageList" : [ { "alt" : "The Siam Residences exterior view", "height" : "630", "secureUrl" : "https://res.cloudinary.com/traveliko/image/upload/v1689655191/the-siam-residences-bangkok.jpg", "type" : "image/jpeg", "url" : "https://res.cloudinary.com/traveliko/image/upload/v1689655191/the-siam-residences-bangkok.jpg", "width" : "1200" } ], "lastUpdate" : "2026-02-03T16:45:12", "multimedias" : [ { "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 } ], "version" : 3, "videoList" : [ { "alt" : "The Siam Residences exterior view", "height" : "630", "secureUrl" : "https://res.cloudinary.com/traveliko/image/upload/v1689655191/the-siam-residences-bangkok.jpg", "type" : "image/jpeg", "url" : "https://res.cloudinary.com/traveliko/image/upload/v1689655191/the-siam-residences-bangkok.jpg", "width" : "1200" } ] } ] } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] } }, "/api/shortened-url/unique" : { "post" : { "tags" : [ "Shortened URL" ], "summary" : "Check slug available", "description" : "Returns whether the proposed URL slug is free to use for the given entity before creation.", "operationId" : "is-url-slug-unique", "parameters" : [ { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } } ], "requestBody" : { "description" : "URL slug and optional entity identifier to check for uniqueness", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ShortenedUrlUniquenessRequest_Non_Authenticated_Entity" } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Uniqueness check result for the proposed slug", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UniqueResult_Non_Authenticated_Entity" }, "example" : { "unique" : true } } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] } }, "/api/managing-entity/{managingEntityIdentifier}/wink-links/shareable-link/supplier/syndication/entry" : { "post" : { "tags" : [ "Entries" ], "summary" : "Add supplier link", "description" : "Syndicates a shareable supplier URL into a new WinkLinks entry.", "operationId" : "create-supplier-url-syndication-entry", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "Managing entity identifier to create item for.", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } } ], "requestBody" : { "description" : "Supplier URL details to syndicate into a new WinkLinks entry", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateSyndicatedItemFromSellableSupplierUrlRequest_ManagingEntity" } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "201" : { "description" : "WinkLinks entry created from supplier URL", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SyndicatedItemLightweight_ManagingEntity" } } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] } }, "/api/managing-entity/{managingEntityIdentifier}/wink-links/shareable-link/inventory/syndication/entry" : { "post" : { "tags" : [ "Entries" ], "summary" : "Add inventory link", "description" : "Syndicates a shareable inventory URL into a new WinkLinks entry.", "operationId" : "create-inventory-url-syndication-entry", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "Managing entity identifier to create item for.", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } } ], "requestBody" : { "description" : "Inventory URL details to syndicate into a new WinkLinks entry", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateSyndicatedItemFromSellableInventoryUrlRequest_ManagingEntity" } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "201" : { "description" : "WinkLinks entry created from inventory URL", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SyndicatedItemLightweight_ManagingEntity" } } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] } }, "/api/managing-entity/{managingEntityIdentifier}/wink-links/ranked-grids/syndication/entry" : { "post" : { "tags" : [ "Entries" ], "summary" : "Add ranked grid", "description" : "Syndicates a sellable ranked list into a new WinkLinks grid entry.", "operationId" : "create-seller-inventory-ranked-list-syndication-entry", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "Managing entity identifier to create item for.", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } } ], "requestBody" : { "description" : "Ranked list details to syndicate into a new WinkLinks grid entry", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateSellableRankedListSyndicatedItemRequest_ManagingEntity" } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "201" : { "description" : "WinkLinks entry created from ranked list", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SyndicatedItemLightweight_ManagingEntity" } } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] } }, "/api/managing-entity/{managingEntityIdentifier}/wink-links/map/syndication/entry" : { "post" : { "tags" : [ "Entries" ], "summary" : "Add map", "description" : "Syndicates an inventory map into a new WinkLinks entry.", "operationId" : "create-map-syndication-entry", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "Managing entity identifier to create item for.", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } } ], "requestBody" : { "description" : "Map configuration to syndicate into a new WinkLinks entry", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateInventoryMapSyndicationEntryRequest_ManagingEntity" } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "201" : { "description" : "WinkLinks entry created from inventory map", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SyndicatedItemLightweight_ManagingEntity" } } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] } }, "/api/managing-entity/{managingEntityIdentifier}/wink-links/items/syndication/entry" : { "post" : { "tags" : [ "Entries" ], "summary" : "Add item", "description" : "Syndicates a single sellable item into a new WinkLinks entry.", "operationId" : "create-seller-inventory-item-syndication-entry", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "Managing entity identifier to create item for.", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } } ], "requestBody" : { "description" : "Sellable item details to syndicate into a new WinkLinks entry", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateSellableItemSyndicatedItemRequest_ManagingEntity" } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "201" : { "description" : "WinkLinks entry created from sellable item", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SyndicatedItemLightweight_ManagingEntity" } } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] } }, "/api/managing-entity/{managingEntityIdentifier}/wink-links/grids/syndication/entry" : { "post" : { "tags" : [ "Entries" ], "summary" : "Add static grid", "description" : "Syndicates a curated static list into a new WinkLinks grid entry.", "operationId" : "create-seller-inventory-list-syndication-entry", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "Managing entity identifier to create item for.", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } } ], "requestBody" : { "description" : "Static list details to syndicate into a new WinkLinks grid entry", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateStaticListSyndicationEntryRequest_ManagingEntity" } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "201" : { "description" : "WinkLinks entry created from static list", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SyndicatedItemLightweight_ManagingEntity" } } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] } }, "/api/managing-entity/{managingEntityIdentifier}/wink-links/syndication/entry" : { "post" : { "tags" : [ "Entries" ], "summary" : "Create", "description" : "Creates a new WinkLinks entry from a fully specified upsert payload.", "operationId" : "create-syndication-entry", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "Create entry for this managing entity identifier.", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } } ], "requestBody" : { "description" : "WinkLinks entry to create", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UpsertSyndicatedItem_ManagingEntity" } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "201" : { "description" : "WinkLinks entry created", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SyndicatedItemLightweight_ManagingEntity" } } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] } }, "/api/managing-entity/{managingEntityIdentifier}/wink-links/syndication/category" : { "post" : { "tags" : [ "Tags" ], "summary" : "Create", "description" : "Creates a new syndication category for the managing entity and returns the persisted record.", "operationId" : "create-syndication-category", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "Create category for this managing entity identifier.", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } } ], "requestBody" : { "description" : "Category to create", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UpsertSyndicationCategory_ManagingEntity" } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "201" : { "description" : "Syndication category created", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SyndicationCategoryLightweight_ManagingEntity" } } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] } }, "/api/managing-entity/{managingEntityIdentifier}/wink-links/shortened-url/{shortenedUrlIdentifier}/copy" : { "post" : { "tags" : [ "Entries" ], "summary" : "Copy from short URL", "description" : "Creates a WinkLinks entry by cloning the target of an existing shortened URL.", "operationId" : "copy-shortened-url", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "Copy for this managing entity identifier.", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "shortenedUrlIdentifier", "in" : "path", "description" : "Shortened URL identifier.", "required" : true, "schema" : { "type" : "string" }, "example" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } } ], "requestBody" : { "description" : "Copy request details", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CopyShortenedUrl_ManagingEntity" } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "202" : { "description" : "WinkLinks entry creation from shortened URL accepted", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SyndicatedItemLightweight_ManagingEntity" } } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] } }, "/api/managing-entity/{managingEntityIdentifier}/wink-links/shortened-url/consume-external-url" : { "post" : { "tags" : [ "Shortened URL" ], "summary" : "Create from external URL", "description" : "Scrapes Open Graph metadata from an external URL and creates a shortened URL entry from it.", "operationId" : "consume-external-url", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "Managing entity that will own the shortened URL", "required" : true, "schema" : { "type" : "string", "format" : "uuid" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } } ], "requestBody" : { "description" : "External URL to scrape for Open Graph metadata and optional syndication flag", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConsumeExternalUrlRequest_ManagingEntity" } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Shortened URL created from the external URL's Open Graph metadata", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ShortenedUrlLightweight_ManagingEntity" }, "example" : { "audioList" : [ { "alt" : "The Siam Residences exterior view", "height" : "630", "secureUrl" : "https://res.cloudinary.com/traveliko/image/upload/v1689655191/the-siam-residences-bangkok.jpg", "type" : "image/jpeg", "url" : "https://res.cloudinary.com/traveliko/image/upload/v1689655191/the-siam-residences-bangkok.jpg", "width" : "1200" } ], "createdDate" : "2026-01-14T09:30:00", "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" } ], "id" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "imageList" : [ { "alt" : "The Siam Residences exterior view", "height" : "630", "secureUrl" : "https://res.cloudinary.com/traveliko/image/upload/v1689655191/the-siam-residences-bangkok.jpg", "type" : "image/jpeg", "url" : "https://res.cloudinary.com/traveliko/image/upload/v1689655191/the-siam-residences-bangkok.jpg", "width" : "1200" } ], "lastUpdate" : "2026-02-03T16:45:12", "multimedias" : [ { "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 } ], "version" : 3, "videoList" : [ { "alt" : "The Siam Residences exterior view", "height" : "630", "secureUrl" : "https://res.cloudinary.com/traveliko/image/upload/v1689655191/the-siam-residences-bangkok.jpg", "type" : "image/jpeg", "url" : "https://res.cloudinary.com/traveliko/image/upload/v1689655191/the-siam-residences-bangkok.jpg", "width" : "1200" } ] } } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] } }, "/api/managing-entity/{managingEntityIdentifier}/wink-links/syndication/entry/list/sort" : { "patch" : { "tags" : [ "Entries" ], "summary" : "Reorder", "description" : "Applies new display slots to the entry list from the supplied id/position pairs.", "operationId" : "sort-syndication-entry-list", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "Reorder entries for this managing entity identifier.", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } } ], "requestBody" : { "description" : "List of entry IDs and their new display slots", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Sorted_ManagingEntity" } } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Reordered list of WinkLinks entries", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SyndicatedItemLightweight_ManagingEntity" } }, "example" : [ { "contentUrl" : "https://www.google.com", "createdDate" : "2026-01-14T09:30:00", "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" } ], "disabled" : false, "display" : "Embedding a tweet", "hashTags" : [ "#TravelSolo" ], "id" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "lastUpdate" : "2026-02-03T16:45:12", "lockCode" : "ABC123", "multimedias" : "For web links, it would be the Open Graph image url. For a file upload, it would be the multipart file.", "ownerIdentifier" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "publishDate" : "2026-01-15T10:30:00Z", "publishStatus" : "PUBLISHED", "sort" : 0, "status" : "ACTIVE", "tags" : [ { "label" : "Hotel & Resort", "value" : "HOTEL" } ], "title" : "Google", "type" : "WEB_LINK", "uniqueId" : "https://trvl.as/Hbgt56", "userIdentifier" : "c3a9f2e1-8b4d-4c7a-a1e2-5f0b6d9e2c84", "userTags" : [ "@maniot" ], "version" : 3 } ] } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] } } }, "components" : { "schemas" : { "ProblemDetail" : { "type" : "object", "properties" : { "detail" : { "type" : "string" }, "instance" : { "type" : "string", "format" : "uri" }, "properties" : { "additionalProperties" : { }, "type" : "object" }, "status" : { "type" : "integer", "format" : "int32" }, "title" : { "type" : "string" }, "type" : { "type" : "string", "format" : "uri" } } }, "CustomizationThemeColors_ManagingEntity" : { "type" : "object", "description" : "Bootstrap-compatible color palette used to style the booking engine web components; all values are CSS hex color codes", "example" : { "body" : "#212529", "danger" : "#dc3545", "dark" : "#343a40", "info" : "#17a2b8", "light" : "#f8f9fa", "muted" : "#6c757d", "primary" : "#dc3545", "secondary" : "#6c757d", "success" : "#28a745", "warning" : "#ffc107", "white" : "#ffffff" }, "properties" : { "body" : { "type" : "string", "default" : "#212529", "description" : "Body color", "example" : "#212529" }, "danger" : { "type" : "string", "default" : "#dc3545", "description" : "Danger color", "example" : "#dc3545" }, "dark" : { "type" : "string", "default" : "#343a40", "description" : "Dark color", "example" : "#343a40" }, "info" : { "type" : "string", "default" : "#17a2b8", "description" : "Info color", "example" : "#17a2b8" }, "light" : { "type" : "string", "default" : "#f8f9fa", "description" : "Light color", "example" : "#f8f9fa" }, "muted" : { "type" : "string", "default" : "#6c757d", "description" : "Muted color", "example" : "#6c757d" }, "primary" : { "type" : "string", "default" : "#dc3545", "description" : "Primary color", "example" : "#dc3545" }, "secondary" : { "type" : "string", "default" : "#6c757d", "description" : "Secondary color", "example" : "#6c757d" }, "success" : { "type" : "string", "default" : "#28a745", "description" : "Success color", "example" : "#28a745" }, "warning" : { "type" : "string", "default" : "#ffc107", "description" : "Warning color", "example" : "#ffc107" }, "white" : { "type" : "string", "default" : "#ffffff", "description" : "White color", "example" : "#ffffff" } } }, "MediaAuthorAttribution_ManagingEntity" : { "type" : "object", "example" : { "name" : "Samuel Adams", "url" : "https://maps.google.com/maps/contrib/111628493169070103594" }, "properties" : { "name" : { "type" : "string", "description" : "Name of contributor", "example" : "Samuel Adams", "minLength" : 1 }, "url" : { "type" : "string", "format" : "uri", "description" : "URL to contributor", "example" : "https://maps.google.com/maps/contrib/111628493169070103594" } }, "required" : [ "name" ] }, "SimpleDescription_ManagingEntity" : { "type" : "object", "description" : "Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.", "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" }, "properties" : { "creator" : { "type" : "string", "default" : "USER", "description" : "Whether it was user or system generated.", "enum" : [ "SYSTEM", "USER" ], "example" : "SYSTEM" }, "description" : { "type" : "string", "description" : "Longer text description", "example" : "This is a longer description in the specified language.", "maxLength" : 2147483647, "minLength" : 1 }, "hashMismatch" : { "type" : "boolean", "readOnly" : true }, "language" : { "type" : "string", "default" : "en", "description" : "Indicate which language this description is written in.", "example" : "en", "maxLength" : 2, "minLength" : 2, "pattern" : "^[a-z]{2}(-[A-Z]{2})?$" }, "md5ContentHash" : { "type" : "string", "description" : "The md5 hash of the name, description and language.", "example" : "d41d8cd98f00b204e9800998ecf8427e" }, "name" : { "type" : "string", "description" : "Use as title or short text description", "example" : "An example title" } }, "required" : [ "description", "language", "name" ] }, "SimpleMultimedia_ManagingEntity" : { "type" : "object", "description" : "Multimedia that contains less information than Multimedia object", "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 }, "properties" : { "angle" : { "type" : "string", "description" : "Media angle", "example" : "-90" }, "attribution" : { "type" : "array", "description" : "Whether image has attribution properties", "items" : { "$ref" : "#/components/schemas/MediaAuthorAttribution_ManagingEntity" } }, "category" : { "type" : "string", "description" : "Supported OTA specification `PIC` code. See [OTA geoname data](#operation/showAvailableCodesForCategory)", "example" : "1" }, "descriptions" : { "type" : "array", "description" : "Localized media captions to give user some context about where this media was taken.", "items" : { "$ref" : "#/components/schemas/SimpleDescription_ManagingEntity" } }, "height" : { "type" : "integer", "format" : "int32", "description" : "Media height in pixels.", "example" : 1600, "minimum" : 1 }, "identifier" : { "type" : "string", "description" : "Use this identifier to communicate with Cloudinary.", "example" : "cloudinary-image-1", "minLength" : 1 }, "isLandscape" : { "type" : "boolean", "description" : "True if media width is greater or equal to height", "example" : true }, "lifestyleType" : { "type" : "string", "description" : "Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.", "enum" : [ "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" : { "type" : "string", "format" : "uuid", "description" : "Document identifier", "example" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "minLength" : 1 }, "published" : { "type" : "boolean", "default" : false, "description" : "Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.", "example" : true }, "sort" : { "type" : "integer", "format" : "int32", "default" : 999, "description" : "Sort allows you to control how you want to sort this record in a list of media records.", "example" : 10 }, "source" : { "type" : "string", "default" : "CLOUDINARY", "description" : "Currently ONLY using Cloudinary to store all image / video assets.", "enum" : [ "YOUTUBE", "CLOUDINARY" ], "example" : "CLOUDINARY" }, "type" : { "type" : "string", "description" : "Whether Cloudinary media is a VIDEO or IMAGE.", "enum" : [ "IMAGE", "VIDEO", "AUDIO", "RAW" ], "example" : "IMAGE" }, "width" : { "type" : "integer", "format" : "int32", "description" : "Media width in pixels.", "example" : 2560, "minimum" : 1 } }, "required" : [ "height", "identifier", "multimediaIdentifier", "sort", "source", "type", "width" ] }, "SyndicationSettingsQrCodeOptions_ManagingEntity" : { "type" : "object", "description" : "Full visual customization options for the QR code displayed on a WinkLinks profile page, covering shape, dot style, corner styles, gradients, and colors for every QR code element.", "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" }, "properties" : { "backgroundEndColor" : { "type" : "string", "description" : "Corner square gradient color", "example" : "#FFFFFF" }, "backgroundGradientRotation" : { "type" : "integer", "format" : "int32", "default" : 0, "description" : "Corners square gradient rotation", "example" : 5 }, "backgroundGradientType" : { "type" : "string", "default" : "LINEAR", "description" : "Corners square gradient", "enum" : [ "LINEAR", "RADIAL" ], "example" : "LINEAR" }, "backgroundRound" : { "type" : "integer", "format" : "int32", "default" : 0, "description" : "Corner square type", "example" : 0 }, "backgroundStartColor" : { "type" : "string", "description" : "Corner square primary color", "example" : "#000000" }, "cornerDotEndColor" : { "type" : "string", "description" : "Corner dot gradient color", "example" : "#FFFFFF" }, "cornerDotGradientRotation" : { "type" : "integer", "format" : "int32", "default" : 0, "description" : "Corners dot gradient rotation", "example" : 5 }, "cornerDotGradientType" : { "type" : "string", "default" : "LINEAR", "description" : "Corners dot gradient", "enum" : [ "LINEAR", "RADIAL" ], "example" : "LINEAR" }, "cornerDotStartColor" : { "type" : "string", "description" : "Corner dot primary color", "example" : "#000000" }, "cornerDotType" : { "type" : "string", "default" : "SQUARE", "description" : "Corner dot type", "enum" : [ "SQUARE", "DOT" ], "example" : "SQUARE" }, "cornerSquareEndColor" : { "type" : "string", "description" : "Corner square gradient color", "example" : "#FFFFFF" }, "cornerSquareGradientRotation" : { "type" : "integer", "format" : "int32", "default" : 0, "description" : "Corners square gradient rotation", "example" : 5 }, "cornerSquareGradientType" : { "type" : "string", "default" : "LINEAR", "description" : "Corners square gradient", "enum" : [ "LINEAR", "RADIAL" ], "example" : "LINEAR" }, "cornerSquareStartColor" : { "type" : "string", "description" : "Corner square primary color", "example" : "#000000" }, "cornerSquareType" : { "type" : "string", "default" : "SQUARE", "description" : "Corner square type", "enum" : [ "SQUARE", "EXTRA_ROUNDED", "DOT" ], "example" : "SQUARE" }, "dotsEndColor" : { "type" : "string", "description" : "Dots gradient color", "example" : "#FFFFFF" }, "dotsGradientRotation" : { "type" : "integer", "format" : "int32", "default" : 0, "description" : "Dots gradient rotation", "example" : 5 }, "dotsGradientType" : { "type" : "string", "default" : "LINEAR", "description" : "Dots gradient", "enum" : [ "LINEAR", "RADIAL" ], "example" : "LINEAR" }, "dotsRoundSize" : { "type" : "boolean", "default" : true, "description" : "Dots round size", "example" : true }, "dotsStartColor" : { "type" : "string", "description" : "Dots primary color", "example" : "#000000" }, "dotsType" : { "type" : "string", "default" : "SQUARE", "description" : "QR code shape", "enum" : [ "DOTS", "ROUNDED", "CLASSY", "CLASSY_ROUNDED", "SQUARE", "EXTRA_ROUNDED" ], "example" : "SQUARE" }, "imageIdentifier" : { "type" : "string", "description" : "Custom image ID for subscribers", "example" : "abc123" }, "shape" : { "type" : "string", "default" : "SQUARE", "description" : "QR code shape", "enum" : [ "SQUARE", "CIRCLE" ], "example" : "CIRCLE" } } }, "UpsertSyndicationSettings_ManagingEntity" : { "type" : "object", "description" : "Request payload for creating or updating the display and layout settings for a WinkLinks profile page.", "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" } }, "properties" : { "accountNameSize" : { "type" : "string", "default" : "LG", "description" : "Account name heading size", "enum" : [ "SM", "MD", "LG", "XL" ], "example" : "LG" }, "customizationIdentifier" : { "type" : "string", "format" : "uuid", "description" : "Customization identifier for this WinkLinks account", "example" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "minLength" : 1 }, "desktopBackgroundImage" : { "$ref" : "#/components/schemas/SimpleMultimedia_ManagingEntity", "description" : "Desktop background image" }, "desktopGradientAngle" : { "type" : "integer", "format" : "int32", "default" : 180, "description" : "Desktop gradient angle in degrees (0-360)", "example" : 180 }, "desktopGradientEnabled" : { "type" : "boolean", "default" : false, "description" : "Whether the desktop gradient background is enabled", "example" : false }, "desktopGradientType" : { "type" : "string", "default" : "LINEAR", "description" : "Desktop gradient type", "enum" : [ "LINEAR", "RADIAL" ], "example" : "LINEAR" }, "desktopPattern" : { "type" : "string", "description" : "Desktop background pattern type", "enum" : [ "GRID", "DOT_MATRIX", "DIAGONAL_LINES", "GRADIENT_MESH", "CHECKERBOARD" ], "example" : "GRID" }, "fontId" : { "type" : "string", "description" : "Custom font for account name display", "enum" : [ "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" : { "type" : "string", "description" : "Whether to treat all links as flat web links or try to embed more advanced data.", "enum" : [ "FROM_LAYOUT", "BANNER", "BANNER_INTELLIGENT" ], "example" : "Embedding a tweet" }, "layoutDisplay" : { "type" : "string", "default" : "GRID_COLUMNS", "description" : "Which way to display the list when WinkLinks first loads", "enum" : [ "LIST", "GRID_ROWS", "GRID_COLUMNS", "GRID_SINGLE_COLUMN" ], "example" : "LIST" }, "mobileBackgroundImage" : { "$ref" : "#/components/schemas/SimpleMultimedia_ManagingEntity", "description" : "Mobile background image" }, "mobileGradientAngle" : { "type" : "integer", "format" : "int32", "default" : 180, "description" : "Mobile gradient angle in degrees (0-360)", "example" : 180 }, "mobileGradientEnabled" : { "type" : "boolean", "default" : false, "description" : "Whether the mobile gradient background is enabled", "example" : false }, "mobileGradientType" : { "type" : "string", "default" : "LINEAR", "description" : "Mobile gradient type", "enum" : [ "LINEAR", "RADIAL" ], "example" : "LINEAR" }, "mobilePattern" : { "type" : "string", "description" : "Mobile background pattern type", "enum" : [ "GRID", "DOT_MATRIX", "DIAGONAL_LINES", "GRADIENT_MESH", "CHECKERBOARD" ], "example" : "GRID" }, "onlinePresencePosition" : { "type" : "string", "default" : "TOP", "description" : "Where to show the online presence icons", "enum" : [ "TOP", "BOTTOM" ], "example" : "BOTTOM" }, "profilePictureGeometry" : { "type" : "string", "default" : "CIRCLE", "description" : "Controls how to display profile picture", "enum" : [ "CIRCLE", "RECTANGLE", "HERO" ], "example" : "CIRCLE" }, "profilePictureSize" : { "type" : "string", "default" : "MD", "description" : "Profile picture size for circle and rectangle geometries", "enum" : [ "SM", "MD", "LG" ], "example" : "MD" }, "qrCodeOptions" : { "$ref" : "#/components/schemas/SyndicationSettingsQrCodeOptions_ManagingEntity", "description" : "Customizable QR code options" }, "themeColors" : { "$ref" : "#/components/schemas/CustomizationThemeColors_ManagingEntity", "description" : "Theme colors are connected with the primary account customization." } }, "required" : [ "customizationIdentifier", "itemDisplay" ] }, "SyndicationSettingsWithThemeColors_ManagingEntity" : { "type" : "object", "description" : "WinkLinks display settings enriched with the resolved theme colors from the account's active customization, used when rendering the public profile page.", "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" }, "properties" : { "accountNameSize" : { "type" : "string", "default" : "LG", "description" : "Account name heading size", "enum" : [ "SM", "MD", "LG", "XL" ], "example" : "LG" }, "createdDate" : { "type" : [ "string", "null" ], "format" : "date-time", "description" : "Datetime this record was first created", "example" : "2026-01-14T09:30:00", "readOnly" : true }, "customizationIdentifier" : { "type" : "string", "format" : "uuid", "description" : "Customization identifier", "example" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "minLength" : 1 }, "desktopBackgroundImage" : { "$ref" : "#/components/schemas/SimpleMultimedia_ManagingEntity", "description" : "Desktop background image" }, "desktopGradientAngle" : { "type" : "integer", "format" : "int32", "default" : 180, "description" : "Desktop gradient angle in degrees (0-360)", "example" : 180 }, "desktopGradientEnabled" : { "type" : "boolean", "default" : false, "description" : "Whether the desktop gradient background is enabled", "example" : false }, "desktopGradientType" : { "type" : "string", "default" : "LINEAR", "description" : "Desktop gradient type", "enum" : [ "LINEAR", "RADIAL" ], "example" : "LINEAR" }, "desktopPattern" : { "type" : "string", "description" : "Desktop background pattern type", "enum" : [ "GRID", "DOT_MATRIX", "DIAGONAL_LINES", "GRADIENT_MESH", "CHECKERBOARD" ], "example" : "GRID" }, "fontId" : { "type" : "string", "description" : "Custom font for account name display", "enum" : [ "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" }, "id" : { "type" : "string", "format" : "uuid", "description" : "Unique identifier for this record.", "example" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47" }, "itemDisplay" : { "type" : "string", "description" : "Whether to treat all links as flat web links or try to embed more advanced data.", "enum" : [ "FROM_LAYOUT", "BANNER", "BANNER_INTELLIGENT" ], "example" : "Embedding a tweet" }, "lastUpdate" : { "type" : [ "string", "null" ], "format" : "date-time", "description" : "Datetime this record was last updated", "example" : "2026-02-03T16:45:12", "readOnly" : true }, "layoutDisplay" : { "type" : "string", "default" : "GRID_COLUMNS", "description" : "Which way to itemDisplay the list when WinkLinks first loads", "enum" : [ "LIST", "GRID_ROWS", "GRID_COLUMNS", "GRID_SINGLE_COLUMN" ], "example" : "LIST" }, "mobileBackgroundImage" : { "$ref" : "#/components/schemas/SimpleMultimedia_ManagingEntity", "description" : "Mobile background image" }, "mobileGradientAngle" : { "type" : "integer", "format" : "int32", "default" : 180, "description" : "Mobile gradient angle in degrees (0-360)", "example" : 180 }, "mobileGradientEnabled" : { "type" : "boolean", "default" : false, "description" : "Whether the mobile gradient background is enabled", "example" : false }, "mobileGradientType" : { "type" : "string", "default" : "LINEAR", "description" : "Mobile gradient type", "enum" : [ "LINEAR", "RADIAL" ], "example" : "LINEAR" }, "mobilePattern" : { "type" : "string", "description" : "Mobile background pattern type", "enum" : [ "GRID", "DOT_MATRIX", "DIAGONAL_LINES", "GRADIENT_MESH", "CHECKERBOARD" ], "example" : "GRID" }, "onlinePresencePosition" : { "type" : "string", "default" : "TOP", "description" : "Where to show the online presence icons", "enum" : [ "TOP", "BOTTOM" ], "example" : "BOTTOM" }, "ownerIdentifier" : { "type" : "string", "format" : "uuid", "description" : "The user's owner company this entry associates with", "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "minLength" : 1 }, "profilePictureGeometry" : { "type" : "string", "default" : "CIRCLE", "description" : "Controls how to itemDisplay profile picture", "enum" : [ "CIRCLE", "RECTANGLE", "HERO" ], "example" : "CIRCLE" }, "profilePictureSize" : { "type" : "string", "default" : "MD", "description" : "Profile picture size for circle and rectangle geometries", "enum" : [ "SM", "MD", "LG" ], "example" : "MD" }, "qrCodeOptions" : { "$ref" : "#/components/schemas/SyndicationSettingsQrCodeOptions_ManagingEntity", "description" : "Customizable QR code options" }, "themeColors" : { "$ref" : "#/components/schemas/CustomizationThemeColors_ManagingEntity", "description" : "Theme colors are connected with the primary account customization." }, "userIdentifier" : { "type" : "string", "format" : "uuid", "description" : "Creator of entry", "example" : "c3a9f2e1-8b4d-4c7a-a1e2-5f0b6d9e2c84", "minLength" : 1 }, "version" : { "type" : [ "integer", "null" ], "format" : "int64", "description" : "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" : 3 } }, "required" : [ "customizationIdentifier", "ownerIdentifier", "userIdentifier" ] }, "KeyValuePair_ManagingEntity" : { "type" : "object", "description" : "Immutable key-value pair associating a machine-readable value with a human-readable label.", "example" : { "label" : "Hotel & Resort", "value" : "HOTEL" }, "properties" : { "label" : { "type" : "string", "description" : "English readable text of the value.", "example" : "Readable text label", "minLength" : 1 }, "value" : { "type" : "string", "description" : "The value that should be persisted.", "example" : "id-1", "minLength" : 1 } }, "required" : [ "label", "value" ] }, "UpsertSyndicatedItem_ManagingEntity" : { "type" : "object", "description" : "Request payload for creating or updating a syndicated item on a WinkLinks profile page.", "example" : { "contentUrl" : "https://www.thesiamresidences.com/explore", "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" } ], "disabled" : false, "display" : "Embedding a tweet", "hashTags" : [ "TravelSolo" ], "lockCode" : "ABC1234", "multimedias" : "For web links, it would be the Open Graph image url. For a file upload, it would be the multipart file.", "publishDate" : "2026-01-15T10:30:00Z", "publishStatus" : "PUBLISHED", "sort" : 0, "tags" : [ { "label" : "Hotel & Resort", "value" : "HOTEL" } ], "title" : "Explore Our Luxury Collection", "type" : "WEB_LINK", "uniqueId" : "siam1", "userTags" : [ "maniot" ] }, "properties" : { "contentUrl" : { "type" : "string", "format" : "uri", "description" : "The URL of this entry", "example" : "https://www.thesiamresidences.com/explore", "minLength" : 1 }, "descriptions" : { "type" : "array", "description" : "Localized descriptions describing inventory.", "items" : { "$ref" : "#/components/schemas/SimpleDescription_ManagingEntity" }, "minItems" : 1 }, "disabled" : { "type" : "boolean", "default" : false, "description" : "Whether author wants to disable the post.", "example" : false }, "display" : { "type" : "string", "description" : "Whether to treat all links as flat web links or try to embed more advanced data.", "enum" : [ "FROM_SETTINGS", "FROM_LAYOUT", "BANNER", "BANNER_INTELLIGENT" ], "example" : "Embedding a tweet" }, "hashTags" : { "type" : "array", "items" : { "type" : "string", "description" : "Hashtags to include in the post (without # prefix).", "example" : "TravelSolo" } }, "lockCode" : { "type" : "string", "description" : "Optional code the author can require be entered by the user in order to access the post.", "example" : "ABC1234" }, "metadata" : { "type" : "object", "additionalProperties" : { }, "description" : "Extended metadata" }, "multimedias" : { "type" : "array", "description" : "The main media for this entry.", "example" : "For web links, it would be the Open Graph image url. For a file upload, it would be the multipart file.", "items" : { "$ref" : "#/components/schemas/SimpleMultimedia_ManagingEntity" } }, "publishDate" : { "type" : "string", "format" : "date-time", "description" : "An optional date for when this post will be displayed.", "example" : "2026-01-15T10:30:00Z" }, "publishStatus" : { "type" : "string", "default" : "PUBLISHED", "description" : "Publish status of post.", "enum" : [ "PUBLISHED", "ARCHIVED" ], "example" : "PUBLISHED" }, "sort" : { "type" : "integer", "format" : "int32", "description" : "Display slot for this entry (0-based index)", "example" : 0 }, "tags" : { "type" : "array", "description" : "Optional user categories", "items" : { "$ref" : "#/components/schemas/KeyValuePair_ManagingEntity" } }, "title" : { "type" : "string", "description" : "The title of this entry", "example" : "Explore Our Luxury Collection", "minLength" : 1 }, "type" : { "type" : "string", "description" : "The syndication entry type", "enum" : [ "WEB_LINK", "MAP", "GRID", "CARD", "FILE", "QUOTE", "POST", "LOCKED" ], "example" : "WEB_LINK" }, "uniqueId" : { "type" : "string", "description" : "Optional 5-character unique code that can be used to access this record.", "example" : "siam1", "maxLength" : 5, "minLength" : 5 }, "userTags" : { "type" : "array", "items" : { "type" : "string", "description" : "User identifiers to tag in the post (without @ prefix).", "example" : "maniot" } } }, "required" : [ "contentUrl", "descriptions", "sort", "title", "type" ] }, "SyndicatedItemLightweight_ManagingEntity" : { "type" : "object", "description" : "Lightweight projection of a WinkLinks syndicated entry, representing a single link, card, map, file, or other content type displayed on an affiliate's link-in-bio profile page.", "example" : { "contentUrl" : "https://www.google.com", "createdDate" : "2026-01-14T09:30:00", "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" } ], "disabled" : false, "display" : "Embedding a tweet", "hashTags" : [ "#TravelSolo" ], "id" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "lastUpdate" : "2026-02-03T16:45:12", "lockCode" : "ABC123", "multimedias" : "For web links, it would be the Open Graph image url. For a file upload, it would be the multipart file.", "ownerIdentifier" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "publishDate" : "2026-01-15T10:30:00Z", "publishStatus" : "PUBLISHED", "sort" : 0, "status" : "ACTIVE", "tags" : [ { "label" : "Hotel & Resort", "value" : "HOTEL" } ], "title" : "Google", "type" : "WEB_LINK", "uniqueId" : "https://trvl.as/Hbgt56", "userIdentifier" : "c3a9f2e1-8b4d-4c7a-a1e2-5f0b6d9e2c84", "userTags" : [ "@maniot" ], "version" : 3 }, "properties" : { "contentUrl" : { "type" : "string", "format" : "uri", "description" : "The url of this entry", "example" : "https://www.google.com" }, "createdDate" : { "type" : [ "string", "null" ], "format" : "date-time", "description" : "Datetime this record was first created", "example" : "2026-01-14T09:30:00", "readOnly" : true }, "descriptions" : { "type" : "array", "description" : "Localized descriptions describing inventory.", "items" : { "$ref" : "#/components/schemas/SimpleDescription_ManagingEntity" } }, "disabled" : { "type" : "boolean", "default" : false, "description" : "Whether author wants to disable the post.", "example" : false }, "display" : { "type" : "string", "description" : "Whether to treat all links as flat web links or try to embed more advanced data.", "enum" : [ "FROM_SETTINGS", "FROM_LAYOUT", "BANNER", "BANNER_INTELLIGENT" ], "example" : "Embedding a tweet" }, "hashTags" : { "type" : "array", "items" : { "type" : "string", "description" : "Hash userTags to use in the post. ", "example" : "#TravelSolo" } }, "id" : { "type" : "string", "format" : "uuid", "description" : "Unique identifier for this record.", "example" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47" }, "lastUpdate" : { "type" : [ "string", "null" ], "format" : "date-time", "description" : "Datetime this record was last updated", "example" : "2026-02-03T16:45:12", "readOnly" : true }, "lockCode" : { "type" : "string", "description" : "Optional code the author can require be entered by the user in order to see the post.", "example" : "ABC123" }, "metadata" : { "type" : "object", "additionalProperties" : { }, "description" : "Extended metadata" }, "multimedias" : { "type" : "array", "description" : "The main multimedias for this entry.", "example" : "For web links, it would be the Open Graph image url. For a file upload, it would be the multipart file.", "items" : { "$ref" : "#/components/schemas/SimpleMultimedia_ManagingEntity" } }, "ownerIdentifier" : { "type" : "string", "format" : "uuid", "description" : "The user's owner company this entry associates with", "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, "publishDate" : { "type" : "string", "format" : "date-time", "description" : "An optional date for when this post will be displayed.", "example" : "2026-01-15T10:30:00Z" }, "publishStatus" : { "type" : "string", "default" : "PUBLISHED", "description" : "Publish status of post.", "enum" : [ "PUBLISHED", "ARCHIVED" ], "example" : "PUBLISHED" }, "sort" : { "type" : "integer", "format" : "int32", "description" : "How the author wants this entry to get sorted", "example" : 0 }, "status" : { "type" : "string", "description" : "This can change if it's linked to travel inventory that is no longer available.", "enum" : [ "ACTIVE", "INACTIVE", "REMOVED" ], "example" : "ACTIVE" }, "tags" : { "type" : "array", "description" : "Optional user categories", "items" : { "$ref" : "#/components/schemas/KeyValuePair_ManagingEntity" } }, "title" : { "type" : "string", "description" : "The site name of this entry", "example" : "Google" }, "type" : { "type" : "string", "description" : "The syndication entry type", "enum" : [ "WEB_LINK", "MAP", "GRID", "CARD", "FILE", "QUOTE", "POST", "LOCKED" ], "example" : "WEB_LINK" }, "uniqueId" : { "type" : "string", "description" : "Optional unique code that can be used to access this record.", "example" : "https://trvl.as/Hbgt56" }, "userIdentifier" : { "type" : "string", "format" : "uuid", "description" : "Creator of entry", "example" : "c3a9f2e1-8b4d-4c7a-a1e2-5f0b6d9e2c84" }, "userTags" : { "type" : "array", "items" : { "type" : "string", "description" : "User IDs to tag in the post. ", "example" : "@maniot" } }, "version" : { "type" : [ "integer", "null" ], "format" : "int64", "description" : "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" : 3 } } }, "UpsertSyndicationCategory_ManagingEntity" : { "type" : "object", "description" : "Request payload for creating or renaming a syndication category on a WinkLinks profile.", "example" : { "name" : "Faves" }, "properties" : { "name" : { "type" : "string", "description" : "The name of this category", "example" : "Faves", "minLength" : 1 } }, "required" : [ "name" ] }, "SyndicationCategoryLightweight_ManagingEntity" : { "type" : "object", "description" : "Lightweight projection of a named category (tag) that an affiliate uses to group and filter their WinkLinks syndicated entries.", "example" : { "createdDate" : "2026-01-14T09:30:00", "id" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "lastUpdate" : "2026-02-03T16:45:12", "name" : "Faves", "ownerIdentifier" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "userIdentifier" : "c3a9f2e1-8b4d-4c7a-a1e2-5f0b6d9e2c84", "version" : 3 }, "properties" : { "createdDate" : { "type" : [ "string", "null" ], "format" : "date-time", "description" : "Datetime this record was first created", "example" : "2026-01-14T09:30:00", "readOnly" : true }, "id" : { "type" : "string", "format" : "uuid", "description" : "Unique identifier for this record.", "example" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47" }, "lastUpdate" : { "type" : [ "string", "null" ], "format" : "date-time", "description" : "Datetime this record was last updated", "example" : "2026-02-03T16:45:12", "readOnly" : true }, "name" : { "type" : "string", "description" : "The name of this category", "example" : "Faves" }, "ownerIdentifier" : { "type" : "string", "format" : "uuid", "description" : "The user's owner company this entry associates with", "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, "userIdentifier" : { "type" : "string", "format" : "uuid", "description" : "Creator of entry", "example" : "c3a9f2e1-8b4d-4c7a-a1e2-5f0b6d9e2c84" }, "version" : { "type" : [ "integer", "null" ], "format" : "int64", "description" : "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" : 3 } } }, "OpenGraphMedia_ManagingEntity" : { "type" : "object", "description" : "Open Graph media asset (image, video, or audio)", "example" : { "alt" : "The Siam Residences exterior view", "height" : "630", "secureUrl" : "https://res.cloudinary.com/traveliko/image/upload/v1689655191/the-siam-residences-bangkok.jpg", "type" : "image/jpeg", "url" : "https://res.cloudinary.com/traveliko/image/upload/v1689655191/the-siam-residences-bangkok.jpg", "width" : "1200" }, "properties" : { "alt" : { "type" : "string", "description" : "Alternative text description for accessibility", "example" : "The Siam Residences exterior view" }, "height" : { "type" : "string", "description" : "Media height in pixels", "example" : "630" }, "secureUrl" : { "type" : "string", "format" : "uri", "description" : "HTTPS URL of the media asset", "example" : "https://res.cloudinary.com/traveliko/image/upload/v1689655191/the-siam-residences-bangkok.jpg" }, "type" : { "type" : "string", "description" : "MIME type of the media (image/jpeg, video/mp4, audio/mpeg, etc.)", "example" : "image/jpeg" }, "url" : { "type" : "string", "format" : "uri", "description" : "URL of the media asset", "example" : "https://res.cloudinary.com/traveliko/image/upload/v1689655191/the-siam-residences-bangkok.jpg", "minLength" : 1 }, "width" : { "type" : "string", "description" : "Media width in pixels", "example" : "1200" } }, "required" : [ "url" ] }, "UpsertShortenedUrl_ManagingEntity" : { "type" : "object", "description" : "Request payload for creating or updating a shortened URL entry", "example" : { "audioList" : [ { "alt" : "The Siam Residences exterior view", "height" : "630", "secureUrl" : "https://res.cloudinary.com/traveliko/image/upload/v1689655191/the-siam-residences-bangkok.jpg", "type" : "image/jpeg", "url" : "https://res.cloudinary.com/traveliko/image/upload/v1689655191/the-siam-residences-bangkok.jpg", "width" : "1200" } ], "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" } ], "entityId" : "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "imageList" : [ { "alt" : "The Siam Residences exterior view", "height" : "630", "secureUrl" : "https://res.cloudinary.com/traveliko/image/upload/v1689655191/the-siam-residences-bangkok.jpg", "type" : "image/jpeg", "url" : "https://res.cloudinary.com/traveliko/image/upload/v1689655191/the-siam-residences-bangkok.jpg", "width" : "1200" } ], "multimedias" : [ { "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 } ], "title" : "The Siam Residences, Bangkok", "type" : "URL", "uniqueId" : "the-siam-residences-promo", "url" : "https://www.thesiamresidences.com/luxury-stay", "videoList" : [ { "alt" : "The Siam Residences exterior view", "height" : "630", "secureUrl" : "https://res.cloudinary.com/traveliko/image/upload/v1689655191/the-siam-residences-bangkok.jpg", "type" : "image/jpeg", "url" : "https://res.cloudinary.com/traveliko/image/upload/v1689655191/the-siam-residences-bangkok.jpg", "width" : "1200" } ] }, "properties" : { "audioList" : { "type" : "array", "description" : "Open Graph audio media extracted from the target URL", "items" : { "$ref" : "#/components/schemas/OpenGraphMedia_ManagingEntity" } }, "descriptions" : { "type" : "array", "description" : "Localized descriptions of the shortened URL entry", "items" : { "$ref" : "#/components/schemas/SimpleDescription_ManagingEntity" }, "minItems" : 1 }, "entityId" : { "type" : "string", "format" : "uuid", "description" : "Entity identifier that the uniqueId originates from. Omit for type=URL, required for other types.", "example" : "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18" }, "imageList" : { "type" : "array", "description" : "Open Graph images extracted from the target URL", "items" : { "$ref" : "#/components/schemas/OpenGraphMedia_ManagingEntity" } }, "metadata" : { "type" : "object", "additionalProperties" : { }, "description" : "Extended metadata key-value pairs (e.g., seo keywords, tags)" }, "multimedias" : { "type" : "array", "description" : "Primary media assets associated with this shortened URL", "items" : { "$ref" : "#/components/schemas/SimpleMultimedia_ManagingEntity" } }, "title" : { "type" : "string", "description" : "Display name for this shortened URL", "example" : "The Siam Residences, Bangkok", "minLength" : 1 }, "type" : { "type" : "string", "description" : "Type of entity the uniqueId links to (URL, PROPERTY, BOOKING, etc.)", "enum" : [ "SELLABLE_INVENTORY_SLUG", "SELLABLE_SUPPLIER_SLUG", "AFFILIATE_ACCOUNT_SLUG", "SYNDICATED_ITEM_SLUG", "URL" ], "example" : "URL" }, "uniqueId" : { "type" : "string", "description" : "URL-friendly slug that uniquely identifies this entry within the owner's account", "example" : "the-siam-residences-promo", "minLength" : 1 }, "url" : { "type" : "string", "format" : "uri", "description" : "Target URL to redirect to. Required when type=URL, omit for other types.", "example" : "https://www.thesiamresidences.com/luxury-stay" }, "videoList" : { "type" : "array", "description" : "Open Graph videos extracted from the target URL", "items" : { "$ref" : "#/components/schemas/OpenGraphMedia_ManagingEntity" } } }, "required" : [ "descriptions", "title", "type", "uniqueId" ] }, "ShortenedUrlLightweight_ManagingEntity" : { "type" : "object", "description" : "Lightweight, read-only projection of a shortened URL, used by cross-domain consumers.", "example" : { "audioList" : [ { "alt" : "The Siam Residences exterior view", "height" : "630", "secureUrl" : "https://res.cloudinary.com/traveliko/image/upload/v1689655191/the-siam-residences-bangkok.jpg", "type" : "image/jpeg", "url" : "https://res.cloudinary.com/traveliko/image/upload/v1689655191/the-siam-residences-bangkok.jpg", "width" : "1200" } ], "createdDate" : "2026-01-14T09:30:00", "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" } ], "id" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "imageList" : [ { "alt" : "The Siam Residences exterior view", "height" : "630", "secureUrl" : "https://res.cloudinary.com/traveliko/image/upload/v1689655191/the-siam-residences-bangkok.jpg", "type" : "image/jpeg", "url" : "https://res.cloudinary.com/traveliko/image/upload/v1689655191/the-siam-residences-bangkok.jpg", "width" : "1200" } ], "lastUpdate" : "2026-02-03T16:45:12", "multimedias" : [ { "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 } ], "version" : 3, "videoList" : [ { "alt" : "The Siam Residences exterior view", "height" : "630", "secureUrl" : "https://res.cloudinary.com/traveliko/image/upload/v1689655191/the-siam-residences-bangkok.jpg", "type" : "image/jpeg", "url" : "https://res.cloudinary.com/traveliko/image/upload/v1689655191/the-siam-residences-bangkok.jpg", "width" : "1200" } ] }, "properties" : { "audioList" : { "type" : "array", "description" : "Open Graph audio media extracted from the target URL.", "items" : { "$ref" : "#/components/schemas/OpenGraphMedia_ManagingEntity" } }, "createdDate" : { "type" : [ "string", "null" ], "format" : "date-time", "description" : "Datetime this record was first created", "example" : "2026-01-14T09:30:00", "readOnly" : true }, "descriptions" : { "type" : "array", "description" : "Localized descriptions of the shortened URL entry.", "items" : { "$ref" : "#/components/schemas/SimpleDescription_ManagingEntity" } }, "entityId" : { "type" : "string", "format" : "uuid", "description" : "Entity identifier that the uniqueId originates from. Empty for type=URL." }, "id" : { "type" : "string", "format" : "uuid", "description" : "Unique identifier for this record.", "example" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47" }, "imageList" : { "type" : "array", "description" : "Open Graph images extracted from the target URL.", "items" : { "$ref" : "#/components/schemas/OpenGraphMedia_ManagingEntity" } }, "lastUpdate" : { "type" : [ "string", "null" ], "format" : "date-time", "description" : "Datetime this record was last updated", "example" : "2026-02-03T16:45:12", "readOnly" : true }, "metadata" : { "type" : "object", "additionalProperties" : { }, "description" : "Extended metadata key-value pairs (e.g., seo keywords, tags)." }, "multimedias" : { "type" : "array", "description" : "Primary media assets associated with this shortened URL.", "items" : { "$ref" : "#/components/schemas/SimpleMultimedia_ManagingEntity" } }, "ownerIdentifier" : { "type" : "string", "format" : "uuid", "description" : "Managing entity / owner identifier that owns this shortened URL." }, "previousUniqueIds" : { "type" : "array", "description" : "Previous URL slugs maintained for SEO and backward compatibility.", "items" : { "type" : "string" } }, "title" : { "type" : "string", "description" : "Display name of the shortened URL." }, "type" : { "type" : "string", "description" : "Type of entity the uniqueId links to (URL, PROPERTY, BOOKING, etc.).", "enum" : [ "SELLABLE_INVENTORY_SLUG", "SELLABLE_SUPPLIER_SLUG", "AFFILIATE_ACCOUNT_SLUG", "SYNDICATED_ITEM_SLUG", "URL" ] }, "uniqueId" : { "type" : "string", "description" : "URL-friendly slug that uniquely identifies this entry within the owner's account." }, "url" : { "type" : "string", "format" : "uri", "description" : "Target URL to redirect to. Required when type=URL, omitted for other types." }, "userIdentifier" : { "type" : "string", "format" : "uuid", "description" : "Creator of this shortened URL." }, "version" : { "type" : [ "integer", "null" ], "format" : "int64", "description" : "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" : 3 }, "videoList" : { "type" : "array", "description" : "Open Graph videos extracted from the target URL.", "items" : { "$ref" : "#/components/schemas/OpenGraphMedia_ManagingEntity" } } } }, "ShortenedUrlUniquenessRequest_Non_Authenticated_Entity" : { "type" : "object", "description" : "Request to check whether a URL slug is available for use within the owner's account", "example" : { "entityId" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "uniqueId" : "the-siam-residences-promo" }, "properties" : { "entityId" : { "type" : "string", "format" : "uuid", "description" : "If updating an existing shortened URL, pass its identifier to exclude it from the uniqueness check", "example" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51" }, "uniqueId" : { "type" : "string", "description" : "URL-friendly slug to check for availability within the owner's account", "example" : "the-siam-residences-promo", "minLength" : 1 } }, "required" : [ "uniqueId" ] }, "UniqueResult_Non_Authenticated_Entity" : { "type" : "object", "description" : "Result indicating whether a value is unique within the platform", "example" : { "unique" : true }, "properties" : { "unique" : { "type" : "boolean", "description" : "True if the checked value is unique; false if it already exists", "example" : true } }, "required" : [ "unique" ] }, "CreateSyndicatedItemFromSellableSupplierUrlRequest_ManagingEntity" : { "type" : "object", "example" : { "identifier" : "7c9a2e5f-3d8b-4a1c-b6e2-8f0d1c4a9b3e" }, "properties" : { "identifier" : { "type" : "string", "format" : "uuid", "description" : "Identifier of the shareable supplier link to syndicate to channels", "example" : "7c9a2e5f-3d8b-4a1c-b6e2-8f0d1c4a9b3e", "minLength" : 1 } }, "required" : [ "identifier" ] }, "CreateSyndicatedItemFromSellableInventoryUrlRequest_ManagingEntity" : { "type" : "object", "example" : { "identifier" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47" }, "properties" : { "identifier" : { "type" : "string", "format" : "uuid", "description" : "Shareable link identifier to create a syndication entry from", "example" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "minLength" : 1 } }, "required" : [ "identifier" ] }, "CreateSellableRankedListSyndicatedItemRequest_ManagingEntity" : { "type" : "object", "example" : { "identifier" : "8f3a2c6e-1d5b-4a7f-9e2c-0b4d6a1f8e5c" }, "properties" : { "identifier" : { "type" : "string", "format" : "uuid", "description" : "ID of seller inventory ranked list to create a syndication entry from", "example" : "8f3a2c6e-1d5b-4a7f-9e2c-0b4d6a1f8e5c", "minLength" : 1 } }, "required" : [ "identifier" ] }, "CreateInventoryMapSyndicationEntryRequest_ManagingEntity" : { "type" : "object", "description" : "Request to create a syndication entry from an existing map", "example" : { "identifier" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51" }, "properties" : { "identifier" : { "type" : "string", "format" : "uuid", "description" : "UUID of the map to syndicate", "example" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "minLength" : 1 } }, "required" : [ "identifier" ] }, "CreateSellableItemSyndicatedItemRequest_ManagingEntity" : { "type" : "object", "description" : "Request to create a syndicated copy of an existing sellable item, referencing the source item by its unique identifier.", "example" : { "identifier" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51" }, "properties" : { "identifier" : { "type" : "string", "format" : "uuid", "description" : "ID of seller inventory item to create a syndication entry from", "example" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "minLength" : 1 } }, "required" : [ "identifier" ] }, "CreateStaticListSyndicationEntryRequest_ManagingEntity" : { "type" : "object", "description" : "Request to create a syndication entry that tracks a curated list inventory item over time.", "example" : { "identifier" : "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29" }, "properties" : { "identifier" : { "type" : "string", "format" : "uuid", "description" : "ID of seller inventory item to create a syndication entry from", "example" : "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29", "minLength" : 1 } }, "required" : [ "identifier" ] }, "CopyShortenedUrl_ManagingEntity" : { "type" : "object", "description" : "Request to copy an existing shortened URL entry to a new one", "example" : { "identifier" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51" }, "properties" : { "identifier" : { "type" : "string", "format" : "uuid", "description" : "Identifier of the shortened URL to copy", "example" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "minLength" : 1 } }, "required" : [ "identifier" ] }, "ConsumeExternalUrlRequest_ManagingEntity" : { "type" : "object", "description" : "Request to scrape an external URL for Open Graph metadata and optionally create a social media post", "example" : { "createPost" : false, "url" : "https://www.thesiamresidences.com/luxury-stay" }, "properties" : { "createPost" : { "type" : "boolean", "default" : false, "description" : "Whether to automatically create a syndicated social media post based on the scraped content", "example" : false }, "url" : { "type" : "string", "format" : "uri", "description" : "External URL to scrape for Open Graph metadata and create a shortened URL from", "example" : "https://www.thesiamresidences.com/luxury-stay", "minLength" : 1 } }, "required" : [ "url" ] }, "Sorted_ManagingEntity" : { "type" : "object", "description" : "Sorted object strictly to use for sorting of list items", "example" : { "id" : "list-item-1", "index" : 0 }, "properties" : { "id" : { "type" : "string", "description" : "List item ID", "example" : "list-item-1", "minLength" : 1 }, "index" : { "type" : "integer", "format" : "int32", "description" : "List item position", "example" : 0 } }, "required" : [ "id", "index" ] } }, "securitySchemes" : { "oauth2ClientCredentials" : { "type" : "oauth2", "description" : "Every endpoint is protected with OAuth2 **client credentials**. Create an\n**Application** in your account to obtain a `clientId` and `clientSecret`, then\nexchange them for a short-lived bearer token.\n\n### 1. Request an access token\n`POST` to the **Token URL** below with `Content-Type: application/x-www-form-urlencoded`\nand a body of `grant_type=client_credentials` (optionally `scope=`).\nSend your credentials as HTTP Basic auth:\n`Authorization: Basic base64(clientId + \":\" + clientSecret)`.\n\n### 2. Call the API\nPass the returned token on every request: `Authorization: Bearer `.\n\nTokens carry only the scopes granted to your Application — request the least privilege\nyou need. There is no interactive authorize step and no refresh token for this flow;\nrequest a new token when the current one expires.", "name" : "Client Credentials", "flows" : { "clientCredentials" : { "tokenUrl" : "https://iam.wink.travel/oauth2/token", "scopes" : { "marketing.read" : "View your marketing & promotions.", "marketing.write" : "Create and update your marketing & promotions.", "marketing.remove" : "Delete your marketing & promotions.", "content.read" : "View your property content.", "content.write" : "Create and update your property content.", "content.remove" : "Delete your property content." } } } } } } }