Start a booking (returns a filled-in checkout link)
start_bookingGet a link to HomeMaster's checkout with the address and the visit already filled in, to give to the customer. Nothing is booked or charged by this tool. On the page the customer picks the start time (it is held for 7 minutes), enters their name and phone, types the 6-digit code we send to their WhatsApp, and pays on our payment page. Never pay on the customer's behalf. For a service booked by the job the link opens that service's checkout: give the job_type and unit_count the customer agreed to and the page starts on them (they can still change them). To book a home clean FOR the customer instead, use request_booking: they confirm with one tap on WhatsApp.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| hours | No | Cleaning only: visit length in hours (see find_services for the lengths we sell, e.g. 2, 3 or 4). | |
| service | Yes | Required: the code of the service the customer asked for, from find_services (e.g. cleaning, aircon, sofa_cleaning). cleaning = home cleaning by the hour, general housekeeping only: a deep clean, a spring clean, a move-out clean or one item cleaned is its own service. Every other service is booked by the job: give job_type and unit_count from its card. | |
| job_type | No | Every service but cleaning: the job, a job_type from the service's card (find_services with its code), e.g. general_service for aircon. A service quoted for each job has one: its quotation visit (quotation_visit) or consultation. | |
| frequency | No | Cleaning only: one-time, weekly, or bi-weekly (every 2 weeks). | one-time |
| unit_count | No | Every service but cleaning: how many, in the service's own unit from its card (units, pieces, hours, panels...). 1 for a quotation visit or a consultation. | |
| postal_code | Yes | 6-digit Singapore postal code, e.g. 238823. |