Skip to main content
POST
Send a viewing

Authorizations

Authorization
string
header
required

The agency's secret key, sent as Authorization: Bearer <key>. One key per agency.

Body

application/json

A viewing booked, moved or cancelled in your system, for one person.

external_id
string
required

One per person per viewing.

Required string length: 1 - 128
status
enum<string>
required

booked: it's on (for a moved viewing, send booked with the new time). cancelled: it's off. no_show: they didn't come. completed: it went ahead.

Available options:
booked,
cancelled,
no_show,
completed
scheduled_at
string<date-time>
required

When it starts, with an offset.

property
PropertyRef · object
required

The property an enquiry or viewing is about: your reference, the development, or both.

duration_minutes
integer
default:30

Defaults to 30. A value outside 5 to 480 minutes is treated as 30.

enquiry_external_id
string | null

Your own id. Stored and echoed back as sent, without surrounding spaces.

Required string length: 1 - 128
contact_id
string<uuid> | null

Signal's id for the person, from any event or response.

contact
Contact · object | null

When there's no enquiry: phone required.

transaction_type
enum<string> | null

Required when contact is the only way we can tell who it's for.

Available options:
sale,
letting
negotiator
Negotiator · object | null

Shown to the agency's staff. Never to the viewer.

updated_at
string<date-time> | null

When it last changed in your system. If you send it, an update older than the one we hold is ignored. Without it, the last call wins.

Response

Updated a viewing we already had.

What Signal will do about a viewing you sent.

viewing_id
string<uuid>
required

Signal's id for the viewing.

external_id
string
required

Your viewing id.

feedback
enum<string>
required

scheduled: we'll ask for feedback after it. not_scheduled: we won't (see reason).

Available options:
scheduled,
not_scheduled
reason
enum<string> | null

Why no feedback will be asked for. too_late: we first heard of it more than 2 hours after its start. cancelled / no_show: it didn't go ahead. opted_out, no_consent, no_phone, not_mobile, transaction_type_off, whatsapp_not_connected: as for enquiries.

Available options:
too_late,
cancelled,
no_show,
opted_out,
no_consent,
no_phone,
not_mobile,
transaction_type_off,
whatsapp_not_connected