Schedule viewing
Book a scheduled viewing for a property in an agent's calendar, with the attendee attached.
POST https://cotlet.dev/api/v1/vaultre/properties/{property_id}/viewing/schedule
write Confirm
Adds an event of type Scheduled Viewing, as Calendar > Add Event does. accompanied and confirmed are the two status boxes. Nothing is sent to the attendee, because Vault's email or SMS on confirming is a separate toggle on the event. By default you confirm each call; you can switch that off for this tool.
Parameters
| Name | Type | Description |
|---|---|---|
| property_id string required | string | Property ID from search_properties. |
| contact_id string required | string | Attendee, a contact ID from search_contacts. |
| starts_at datetime required | datetime | Start of the viewing. |
| ends_at datetime required | datetime | End of the viewing. |
| calendar_user string | string | Email of the Vault user whose calendar gets the event. Default: you. |
| accompanied boolean | boolean | Tick the accompanied box. Default: false. |
| confirmed boolean | boolean | Tick the confirmed box. Default: false. |
| notes string | string | Event notes. |
Request
curl -X POST https://cotlet.dev/api/v1/vaultre/properties/22810/viewing/schedule \
-H "Authorization: Bearer $COTLET_API_KEY" \
-H "Content-Type: application/json" \
-d '{"contact_id":"51377","starts_at":"2026-10-24T10:30:00+11:00","ends_at":"2026-10-24T11:00:00+11:00","calendar_user":"sam@harbourlane.example","accompanied":true}'result = client.call("vaultre", "schedule_viewing", {"property_id":"22810","contact_id":"51377","starts_at":"2026-10-24T10:30:00+11:00","ends_at":"2026-10-24T11:00:00+11:00","calendar_user":"sam@harbourlane.example","accompanied":True})const result = await cotlet.call('vaultre', 'schedule_viewing', {"property_id":"22810","contact_id":"51377","starts_at":"2026-10-24T10:30:00+11:00","ends_at":"2026-10-24T11:00:00+11:00","calendar_user":"sam@harbourlane.example","accompanied":true});cotlet call vaultre schedule_viewing --data '{"property_id":"22810","contact_id":"51377","starts_at":"2026-10-24T10:30:00+11:00","ends_at":"2026-10-24T11:00:00+11:00","calendar_user":"sam@harbourlane.example","accompanied":true}'Example response
{
"event_id": "evt_90331",
"type": "scheduled_viewing",
"property": "14 Wattle Street, Marrickville NSW 2204",
"attendee": "Priya Nair",
"calendar_user": "sam@harbourlane.example",
"starts_at": "2026-10-24T10:30:00+11:00",
"ends_at": "2026-10-24T11:00:00+11:00",
"accompanied": true,
"confirmed": false
}