[Cotlet](https://cotlet.dev/index.md) · [Integrations](https://cotlet.dev/integrations.md) · [How it works](https://cotlet.dev/how-it-works.md) · [Use cases](https://cotlet.dev/use-cases.md) · [Security](https://cotlet.dev/security.md) · [For developers](https://cotlet.dev/for-developers.md) · [For automation agencies](https://cotlet.dev/for-agencies.md) · [Blog](https://cotlet.dev/blog.md) · [API docs](https://cotlet.dev/docs.md) · [Help center](https://cotlet.dev/help.md) · [Changelog](https://cotlet.dev/changelog.md) · [Contact](https://cotlet.dev/contact.md) · [Pricing](https://cotlet.dev/pricing.md) · [Sign up](https://cotlet.dev/signup)

# Schedule viewing

> Book a scheduled viewing for a property in an agent's calendar, with the attendee attached. Inputs, cURL, Python and Node.js examples and an example response.

Source: https://cotlet.dev/docs/api/vaultre/schedule_viewing

Docs sections: [Get started](https://cotlet.dev/docs.md) · [REST API](https://cotlet.dev/docs/api.md) · [MCP](https://cotlet.dev/docs/mcp.md) · [SDKs & CLI](https://cotlet.dev/docs/sdks.md) · [Integrations](https://cotlet.dev/docs/integrations.md)

Book a scheduled viewing for a property in an agent's calendar, with the attendee attached.

VaultRE API: https://cotlet.dev/docs/api/vaultre.md

`POST https://cotlet.dev/api/v1/vaultre/properties/{property_id}/viewing/schedule`

Access: write. Confirm: waits for the user's OK before it runs.

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 | Required | Description |
|---|---|---|---|
| `property_id` | string | yes | Property ID from search_properties. |
| `contact_id` | string | yes | Attendee, a contact ID from search_contacts. |
| `starts_at` | datetime | yes | Start of the viewing. |
| `ends_at` | datetime | yes | End of the viewing. |
| `calendar_user` | string | no | Email of the Vault user whose calendar gets the event. Default: you. |
| `accompanied` | boolean | no | Tick the accompanied box. Default: false. |
| `confirmed` | boolean | no | Tick the confirmed box. Default: false. |
| `notes` | string | no | Event notes. |

## Request

**cURL**

```bash
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}'
```

**Python**

```python
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})
```

**Node.js**

```js
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});
```

**CLI**

```bash
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

```json
{
  "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
}
```

Previous: [Add appraisal](https://cotlet.dev/docs/api/vaultre/add_appraisal.md)
Next: [Add open home](https://cotlet.dev/docs/api/vaultre/add_open_home.md)

---

Give your AI agents your signed-in browser.

**Product:** [Integrations](https://cotlet.dev/integrations.md) · [Use cases](https://cotlet.dev/use-cases.md) · [How it works](https://cotlet.dev/how-it-works.md) · [Pricing](https://cotlet.dev/pricing.md) · [Security](https://cotlet.dev/security.md)

**Resources:** [Blog](https://cotlet.dev/blog.md) · [API docs](https://cotlet.dev/docs.md) · [Help center](https://cotlet.dev/help.md) · [Changelog](https://cotlet.dev/changelog.md) · [GitHub](https://github.com/cotletdev/cotlet)

**Solutions:** [For developers](https://cotlet.dev/for-developers.md) · [For automation agencies](https://cotlet.dev/for-agencies.md)

**Company:** [About](https://cotlet.dev/about.md) · [AI info: company facts](https://cotlet.dev/ai-info.md) · [Contact](https://cotlet.dev/contact.md)

**Legal:** [Terms of service](https://cotlet.dev/terms) · [Privacy policy](https://cotlet.dev/privacy) · [Refund policy](https://cotlet.dev/refunds) · [Acceptable use](https://cotlet.dev/acceptable-use) · [Cookie policy](https://cotlet.dev/cookies) · [DPA](https://cotlet.dev/dpa) · [Subprocessors](https://cotlet.dev/subprocessors)

**Elsewhere:** [Status page](https://status.cotlet.dev) · [Cotlet on GitHub](https://github.com/cotletdev) · [Cotlet on X](https://x.com/cotletdev) · [Cotlet on LinkedIn](https://www.linkedin.com/company/cotletdev) · [Cotlet on Product Hunt](https://www.producthunt.com/products/cotlet) · [Cotlet on Crunchbase](https://www.crunchbase.com/organization/cotlet) · [Cotlet on SaaSHub](https://www.saashub.com/cotlet)

Cotlet is an independent service. It is not affiliated with, endorsed by or sponsored by any of the products listed on this site. Product names are trademarks of their respective owners.

## For AI agents: sign your user up

Is your user asking you to sign them up for Cotlet? You can do it for them, no account or key needed.

1. Read the fields and their allowed values: GET https://cotlet.dev/api/v1/access-requests
2. Ask the user for each value: email, apps, what you will do with them. If they leave the password to you, generate a strong one and show it to them.
3. Show the user what you will send, then POST it as JSON to https://cotlet.dev/api/v1/access-requests.

One call creates the account and sends the access request; we email the user when access is granted.