Schedule a new tour

PUT /api/v3/tours/schedule

Creates a new showing/tour for a listing.

Attribution:

A booking made with a partner OAuth token is always recorded as THIRD_PARTY and attributed to the partner application that authenticated. The channel field is ignored for those requests, so there is no need to send it.
The AI_* channels describe scheduling done by ShowMojo's own AI assistant. Reporting them for a booking made on a partner site misattributes the lead.

Bookings can be turned off by the customer:

A customer can allow or block tour bookings for an individual partner, per account, property and listing.
When bookings are off, scheduling fails with Scheduling is not available for this listing, available times come back as an empty array, and screening questions come back as an empty list. An already scheduled tour stays readable through /api/v3/tours/results.

Important Notes on Screening Answers:

For questions with predefined options (PETS, DROPDOWN, BEDROOMS, INCOME), the answer must exactly match one of the provided options
Invalid answers are silently skipped; the prospect will be contacted to provide missing information
For ROOMMATES questions, provide a comma-separated list of names or emails (e.g., "John Doe, jane@example.com, Bob Smith")

Updating an existing lead (lead_id):

When the optional lead_id is supplied, an existing unscheduled lead is updated instead of creating a new showing.
The lead is located by its UID, scoped to your account, and must have no scheduled showtime. If it is not found or already has a showtime, the request fails with a lead_id error and no new showing is created.
On success the lead's contact info and showtime are updated, the lead is associated with the listing_id being scheduled (which may differ from the listing it originally inquired about), the response is identical to the create flow, and tour_id equals the supplied lead_id.
Email matching tolerates partner masked-email addresses (e.g. Zillow @convo.zillow.com, Apartments.com textlead+…@apartments.com): a differing masked email alone does not block scheduling when name and phone match.

Request

Tour scheduled successfully