Hold a time and email the client to confirm
hold_bookingUse this when the person has picked a time from check_availability and said yes to its price and the cancellation policy. Holds that time for up to 15 minutes and emails the person, who confirms it with the link in the email or by reading you the 6-digit code from it. Nothing is booked until they confirm. Pass the person's own name and email address, their time zone and an idempotencyKey: a retry with the same key and details returns the same hold. To change a time you already held, release the earlier hold with release_hold first. Do not use for holding a time for someone who has not given you their own email address, or for taking a payment.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"slotId": "<slotId>",
"client": "<client>",
"clientTimeZone": "<clientTimeZone>",
"idempotencyKey": "<idempotencyKey>"
},
"name": "hold_booking"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| client | Yes | ||
| slotId | Yes | A slotId from check_availability, used within 30 minutes. | |
| language | No | The language to answer in (BCP 47). | |
| partySize | No | ||
| clientTimeZone | Yes | The client's IANA time zone, such as America/Toronto. Ask for their city when unsure. | |
| idempotencyKey | Yes | The same key and the same details for a retry of one hold; a new key for anything else. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| meta | Yes | ||
| holdId | Yes | ||
| sentTo | Yes | The address the email goes to, masked. | |
| status | Yes | ||
| booking | Yes | ||
| demoCode | No | The demo business only: the code to confirm with. | |
| heldUntil | No | ||
| confirmWays | Yes | ||
| bookingPageUrl | Yes | The business's own booking page, for when the email does not arrive. | |
| demoConfirmUrl | No | The demo business only, for an example address that gets no email: the link the email would have carried. The person opens it to confirm. | |
| messageForUser | No | ||
| nextStepIfNoEmail | No | While the time is held for the person: what to do if they have no email after a few minutes. |