Developer Docs
API Reference & Discovery
Scale My Hotel exposes standard public HTTP API endpoints for hotel operators and AI agent clients. Integrations require no authorization and serve structured JSON responses.
Lead Capture & Audit
POST
/api/capture-lead Submit hotel characteristics for booking audits and growth scheduling. Logs details to our database and alerts the consulting team.
Request Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| name | string | Yes | Full name of the contact person |
| string | Yes | Contact email address | |
| phone | string | Yes | Contact phone number (with country code) |
| hotelName | string | Yes | Name of the hotel or resort property |
| rooms | number | No | Number of keys/rooms in the property |
| city | string | No | Location city of the property |
| adr | number | No | Average Daily Rate (ADR) in INR |
| occupancy | number | No | Average occupancy rate percentage (0-100) |
| otaCommission | number | No | Average OTA commission percentage (0-100) |
| message | string | No | Additional comments or requirements |
Example Request Body
{
"name": "Ramesh Kumar",
"email": "[email protected]",
"phone": "+919876543210",
"hotelName": "Beach Resort Goa",
"rooms": 45,
"city": "Goa",
"adr": 6500,
"occupancy": 75,
"otaCommission": 18,
"message": "Looking to audit our current MakeMyTrip listings."
} Example Response
{
"success": true,
"message": "Lead captured successfully",
"data": {
"id": "lead_7f9b8c2d",
"commissionSavingsPotential": 236250
}
} AI Review Response Generator
POST
/api/generate-review-response Generates professional responses to hotel guest reviews based on sentiment and guest details.
Request Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| reviewText | string | Yes | Raw text content of the guest review |
| sentiment | string | Yes | Overall sentiment of the review ('positive', 'neutral', 'negative') |
| guestName | string | No | Name of the guest (if available) |
Example Request Body
{
"reviewText": "We had a wonderful time! The staff was incredibly welcoming and the sea view rooms were spectacular. Will visit again.",
"sentiment": "positive",
"guestName": "Sarah Jenkins"
} Example Response
{
"success": true,
"response": "Dear Sarah Jenkins,\n\nThank you so much for your kind words! We are absolutely thrilled to hear that you had a wonderful time and enjoyed the welcoming service from our team alongside our sea view rooms. We look forward to welcoming you back for another spectacular stay in the future!\n\nWarm regards,\nManagement Team"
} AI WhatsApp Template Generator
POST
/api/generate-whatsapp-templates Generates custom guest-communication templates formatted with WhatsApp markdown symbols.
Request Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| hotelName | string | Yes | Name of your hotel |
| templateType | string | Yes | Category of template (e.g. 'booking_confirmation', 'pre_arrival', 'check_in', 'feedback') |
Example Request Body
{
"hotelName": "Grand Palace Udaipur",
"templateType": "booking_confirmation"
} Example Response
[
{
"id": "template_1",
"label": "Direct Booking Confirmation",
"text": "Hello *[Guest Name]*, thank you for choosing *Grand Palace Udaipur*!\n\nYour booking is confirmed. ๐ *Check-in:* [Check-in Date] | ๐ *Room:* [Room Type].\n\nNeed assistance? Reply here or call us at [Phone]. See you soon!"
}
] AI Message Pack Generator
POST
/api/generate-message-pack Generates a cohesive multi-channel notification package (email draft, SMS, and WhatsApp text) for guest updates.
Request Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| hotelName | string | Yes | Name of the hotel |
| guestName | string | Yes | Name of the guest |
| bookingSource | string | Yes | Where the booking originated ('Direct' or 'OTA') |
Example Request Body
{
"hotelName": "Himalayan Retreat Manali",
"guestName": "Amit Sharma",
"bookingSource": "Direct"
} Example Response
{
"success": true,
"pack": {
"email": {
"subject": "Your Upcoming Stay at Himalayan Retreat Manali",
"body": "Dear Amit Sharma,\n\nThank you for choosing to book directly with Himalayan Retreat Manali. We are preparing for your arrival and look forward to offering you a memorable mountain getaway..."
},
"sms": "Hi Amit, your stay at Himalayan Retreat Manali is confirmed! Need directions or room upgrades? Call us at [Phone].",
"whatsapp": "Hello *Amit Sharma*, we look forward to hosting you at *Himalayan Retreat Manali*! Check-in details and local travel tips are here: [Link]"
}
} Newsletter Subscription
POST
/api/newsletter Subscribe email addresses to the weekly Hospitality Growth & Direct Booking intelligence updates.
Request Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| string | Yes | Subscriber email address |
Example Request Body
{
"email": "[email protected]"
} Example Response
{
"success": true,
"message": "Subscribed successfully"
}