Skip to main content
POST
Create an enquiry

Authorizations

Authorization
string
header
required

API Key authentication. Use "Bearer YOUR_API_KEY".

Body

application/json
assignee
string

The ID of the user to assign the enquiry to.

The ID of the consumer user the enquiry should be linked to.

email
string<email>

The enquirer's email address.

metadata
object | null

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

name
string

The enquirer's full name.

phone
string

The enquirer's phone number.

portal
Rightmove · object

Details about the property portal this enquiry originated from. Set when source is portal.

qualification
object

Qualification data submitted with the enquiry.

qualification_configuration
string

The ID of the qualification configuration the enquiry was submitted against.

source
enum<string>

The channel the enquiry originated from.

Available options:
email,
manual,
phone,
portal,
referral,
web_form,
widget
unit
string

The ID of the unit the lead has expressed interest in.

captcha_token
string

Cloudflare Turnstile token. Required when creating an enquiry with a qualification configuration key.

embed_origin
string

Origin of the website embedding the form. Required when the configuration has allowed origins.

Response

200 - application/json

Returns the enquiry object if the request succeeded.

id
string
required

Unique identifier for the object.

created
number
required

Time at which the object was created. Measured in seconds since the Unix epoch.

object
enum<string>
required
Available options:
leads.enquiry
assignee
string | null
required

The team member the enquiry is assigned to.

email
string | null
required

The enquirer's email address.

name
string | null
required

The enquirer's full name.

phone
string | null
required

The enquirer's phone number.

qualification
object
required

The qualification data captured for this enquiry.

qualification_configuration
required

The qualification configuration the enquiry was submitted against, if any.

referral
object
required

Referral metadata captured when the enquiry was submitted.

reviewed_at
number | null
required

Time at which the enquiry was reviewed. Measured in seconds since the Unix epoch.

reviewed_by
string | null
required

The ID of the user who reviewed the enquiry.

source
enum<string> | null
required

The channel the enquiry originated from.

Available options:
email,
manual,
phone,
portal,
referral,
web_form,
widget,
null
status
enum<string>
required

The status of the enquiry.

Available options:
new,
pending,
contacted,
qualified,
viewing,
application,
won,
lost,
disqualified
unit
required

The most recent unit the lead has expressed interest in, if any.

interests
object[]
required

Units the lead has expressed interest in, in the order they were recorded.

account
string

The account that the object belongs to. Only returned if the request is made with a valid Yorlet-Context header.

deleted
boolean
default:false

Only returned if the object has been deleted.

application
string | null

The application the enquiry was converted into, if any.

metadata
object | null

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

portal
Rightmove · object | null

Details about the property portal this enquiry originated from. Present when source is portal.