Skip to main content
POST
Send an enquiry

Authorizations

Authorization
string
header
required

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

Body

application/json

An enquiry that started in your system: a phone call, a walk-in, your own web form.

external_id
string
required

The ENQUIRY's id, not the contact's. One person, three properties: three ids.

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

sale or letting. Picks the questions Signal asks.

Available options:
sale,
letting
contact
Contact · object
required

A person, as your system holds them.

property
PropertyRef · object
required

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

received_at
string<date-time> | null

When it reached you. Defaults to now. Over 24 hours old: recorded, never messaged.

source
string | null

Where the enquiry came from: daft, myhome, website, phone, walk_in or other. Anything else is recorded as other.

Minimum string length: 1
branch_code
string | null

Which of the agency's branches it belongs to. The codes are agreed with the agency when they join. An unknown code is a 422.

Required string length: 1 - 32

Leave it out unless your capture point records a WhatsApp preference. Absent: the agency's policy applies, which by default starts the conversation. contact_by_whatsapp false: recorded, never messaged.

message
string | null

Their own words. Anything past 2,000 characters is cut off.

Minimum string length: 1
suppress_conversation
boolean
default:false

Record the enquiry and send nothing. For testing.

Response

We already had this external_id. Nothing changed, and the body is the same as the first answer.

What happened to an enquiry you sent.

enquiry_id
string<uuid>
required

Signal's id for the enquiry.

external_id
string
required

Your enquiry id.

conversation
enum<string>
required

starting: the greeting is on its way. existing_contact: we already have a conversation with this mobile number. not_started: recorded, nothing sent (see reason).

Available options:
starting,
existing_contact,
not_started
contact_id
string<uuid> | null

Signal's id for the person. Store it.

reason
enum<string> | null

Why nothing was sent. no_phone: no usable phone number. not_mobile: the number is a landline. no_consent: contact_by_whatsapp was false. opted_out: they've asked us to stop. stale: received more than 24 hours ago. suppressed: suppress_conversation was set, or the number isn't on a dev key's allow-list. transaction_type_off: the agency hasn't switched Signal on for sales, or for lettings. whatsapp_not_connected: the agency's WhatsApp number isn't connected yet.

Available options:
no_phone,
not_mobile,
no_consent,
opted_out,
stale,
suppressed,
transaction_type_off,
whatsapp_not_connected