Skip to content

Select theme

Select language

Getting Started
Portal
- Analytics
- Claims
- Create Account
- Intro to Portal
- Invites
- Leaderboard
- Subscription
- Corporate
  - What is Group?
- Extranet
- Link Manager
- Payment
  - Withdraw Funds
- Settings
- Social
- Studio
- Travel Agent
User Settings
- User Settings (IAM)
- Profile
- Register
Booking Engine
Guides
Webinars
- How Tos
Integrations
Developers
API
- Overview
- Account
- Affiliate
  - Overview
  - Analytics
    
    Overview
    Affiliate booking analytics POST
    Affiliate overview GET
    Charts GET
    Lifetime totals GET
  - Available Suppliers
    
    Overview
    Get supplier details GET
    List recently added suppliers GET
    List supplier cities GET
    List supplier countries GET
    Search suppliers by grid criteria POST
  - Browse
    
    Overview
    Latest suppliers GET
    List cities GET
    List continents GET
    List countries GET
    Search POST
    Search by saved filter GET
    Search by saved list GET
    Search suppliers POST
    Show categories GET
    Show cities GET
    Show continents GET
    Show countries GET
    Show latest GET
    Show supplier GET
  - Catalog
    
    Overview
    Show embeddable GET
  - Curated List
    
    Overview
    Add item POST
    Add supplier item POST
    Copy item POST
    Create POST
    Create from supplier POST
    Move item PUT
    Re-order items PATCH
    Remove DELETE
    Remove item DELETE
    Show all GET
    Update PUT
  - Customization
    
    Overview
    Create POST
    Delete DELETE
    List GET
    Show GET
    Show primary GET
    Update PUT
  - Dynamic List
    
    Overview
    Create POST
    List GET
    Remove DELETE
    Update PUT
  - Grids
    
    Overview
    Create grid POST
    Delete grid DELETE
    List grids GET
    Show grid GET
    Update grid PUT
  - Inventory Links
    
    Overview
    Create shareable inventory link POST
    Delete shareable inventory link DELETE
    Get shareable inventory link GET
    List inventory media GET
    List shareable inventory links GET
    Update shareable inventory link PUT
  - Items
    
    Overview
    Create POST
    Create from supplier POST
    Delete DELETE
    List GET
    List media GET
    Show GET
    Update PUT
  - Leads
    
    Overview
    Create lead (affiliate-initiated) POST
  - Managed Social
    
    Overview
    Calendar POST
    Create post POST
    Create settings POST
    Grid POST
    Remove connection PATCH
    Show post GET
    Show settings GET
    Update post PATCH
    Update settings PATCH
    Update status PATCH
  - Maps
    
    Overview
    Create a map for a supplier POST
    Create a new map POST
    Delete a map DELETE
    Get a single marker GET
    Get a specific map GET
    Get markers for a list GET
    List all maps GET
    Update an existing map PUT
  - Ranked Grids
    
    Overview
    Create a new ranked grid POST
    Delete a ranked grid DELETE
    Get ranked grid by identifier GET
    List all ranked grids GET
    Update a ranked grid PUT
  - Relationship Request
    
    Overview
    Create POST
    Delete DELETE
    List GET
    Re-apply GET
    Show by supplier GET
  - Reports
    
    Overview
    Generate Wink Studio report for travel agent POST
  - Sales Channel
    
    Overview
    Show by supplier GET
    Show page POST
  - Shortened URL
    
    Overview
    Create from external URL POST
    Delete DELETE
    Show all GET
    Show one GET
    Update PUT
  - Supplier Links
    
    Overview
    Create shareable supplier link POST
    Delete shareable supplier link DELETE
    Get shareable supplier link GET
    List shareable supplier links GET
    Update shareable supplier link PUT
  - Syndicated Item
    
    Overview
    Add inventory link POST
    Add item POST
    Add map POST
    Add ranked grid POST
    Add static grid POST
    Add supplier link POST
    Copy from short URL POST
    Create POST
    Delete DELETE
    Reorder PATCH
    Show all GET
    Show one GET
    Update PUT
  - Syndication Category
    
    Overview
    Create POST
    Delete DELETE
    List GET
    Show GET
    Update PUT
  - Syndication Settings
    
    Overview
    Show GET
    Upsert PUT
- Common
  - Overview
  - ACL
    
    Overview
    Hello (DELETE) DELETE
    Hello (GET) GET
    Hello (PATCH) PATCH
    Hello (POST) POST
    Hello (PUT) PUT
  - Activity Stream
    
    Overview
    Create activity stream entry POST
    List activity stream for entity GET
  - Affiliate
    
    Overview
    Leaderboard by owner POST
    Leaderboard by region POST
  - Analytics
    
    Overview
    Create saved chart POST
    Delete saved chart DELETE
    Fetch saved chart GET
    List charts GET
    List saved charts GET
    Search charts POST
    Update saved chart PUT
  - Configuration
    
    Overview
    By ID GET
    By URL name GET
  - Geo Data
    
    Overview
    List continents GET
    List countries GET
    List IANA time zones GET
    Match cities GET
    Search cities by name GET
    Show by ID GET
  - Geo Location
    
    Overview
    Get caller's location from IP GET
    Get location status (legacy) GET
  - Inventory
    
    Overview
    Get public map with markers GET
    Rate calendar POST
    Resolve properties POST
    Resolve property POST
    Resolve with session POST
    Show activity POST
    Show add-on POST
    Show attraction POST
    Show grid POST
    Show grid item POST
    Show guest room POST
    Show meeting room POST
    Show place POST
    Show property POST
    Show ranked grid POST
    Show restaurant POST
    Show spa POST
  - Lookup
    
    Overview
    By city POST
    By geo-location POST
    Get lookup by URL name GET
    Ranked by agency POST
    Ranked by city POST
    Ranked by country POST
    Ranked global POST
    Search destinations GET
  - MarketingCampaign
    
    Overview
    Retrieve campaign content by secure token GET
  - Notification
    
    Overview
    Delete DELETE
    Show mine GET
    Show one GET
    Unread count GET
  - Property Embeddings External
    
    Overview
    Contribute knowledge POST
    Delete external ID mapping DELETE
    List registered mappings GET
    Query property embeddings POST
    Register external ID mapping POST
  - Rate Provider
    
    Overview
    List GET
  - Reference
    
    Overview
    Count GET
    List all perks GET
    List Codes by OTA Category GET
    List currencies GET
    List OTA Categories GET
    List Social Networks GET
    List Supported Languages GET
    List Traveler Lifestyles GET
    Property lookup GET
    Rates for target GET
    Show all GET
    Show countries GET
    Single rate GET
  - Revolut OAuth2 Consent
    
    Overview
    Handle Revolut OAuth2 authorization callback GET
    Initiate Revolut OAuth2 consent flow GET
  - Shortened URL
    
    Overview
    Check slug available POST
  - User Settings
    
    Overview
    Change password PATCH
    Show profile GET
    Update profile PATCH
- Consumer
  - Overview
  - Checkout
    
    Overview
    Initialize direct checkout POST
  - Configuration
    
    Overview
    By ID GET
    By URL name GET
  - Consumer Booking
    
    Overview
    Cancel PATCH
    Cancel group PATCH
    List GET
    List by group GET
    List by review state GET
    List by time GET
    Quote cancellation GET
    Quote group cancellation GET
    Resend confirmation PATCH
    Search POST
    Show GET
    Show by transaction GET
  - Inventory
    
    Overview
    Report unavailable POST
  - Review
    
    Overview
    Show template GET
    Submit POST
  - Shopping Cart
    
    Overview
    Add item to cart PATCH
    Create cart POST
    Delete all carts DELETE
    Delete cart DELETE
    Empty cart DELETE
    List all carts GET
    Remove cart item DELETE
    Remove item ancillary DELETE
    Retrieve cart GET
    Update cart item PATCH
  - Travel Agent
    
    Overview
    Cancel PATCH
    Create POST
    Create (legacy) POST
    Resend confirmation PATCH
    Show GET
    Show grid POST
  - User Settings
    
    Overview
    Retrieve User Profile GET
    Update User Profile PUT
  - User Verification
    
    Overview
    Verify Email Unique POST
- Partner
  - Overview
  - Channel Manager
    
    Overview
    List bookings GET
    List properties GET
    Ping GET
    Show booking GET
    Show daily rates GET
    Show property GET
    Update daily rates PUT
- Supplier
Overview
- Releases
- Application
- Platform

Select theme

Select language

On this page

Overview
Lead
Operations

On this page

Overview
Lead
Operations

Overview

Lead

Section titled “Lead”

Manage your property leads including viewing, updating, and AI-powered suggestions for descriptions and amenities

Try it in Scalar

Operations

Section titled “ Operations ”

POST

/api/lead/{leadIdentifier}/profile/suggest

POST

/api/lead/{leadIdentifier}/welcome-text/suggest

POST

/api/lead/{leadIdentifier}/services/suggest

Previous
Show spa Next
Generate AI-suggested property profile for lead