Creates a commercial enquiry. Used by agency websites and third-party portals to push leads into Loop.

post

https://example.com/v2/commercial/enquiries

The enquiry is created with status new and source api. It may name a
commercial property, or stand alone for appraisal and general leads.

Team scope comes from the API key. A team scoped key writes to its own team, so
teamId may be omitted; if supplied it must match. A client or network scoped key
must supply teamId, and it must be a team the key can reach.

Sizes in sizeMinSqFt and sizeMaxSqFt are square feet.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The enquiry payload

teamId

uuid

commercialPropertyId

int64 | null

commercialEnquiryType

string

enum

Allowed:

title

string | null

firstName

string | null

lastName

string | null

emailAddress

string | null

phone

string | null

contactAddress

string | null

contactPostcode

string | null

preferredContactMethod

string

enum

Allowed:

preferredContactTime

string

enum

Allowed:

message

string | null

requestViewing

boolean

requestPropertyDetails

boolean

sector

string | null

desiredPropertyType

string

enum

Allowed:

desiredOfficeSubType

string

enum

Allowed:

desiredIndustrialSubType

string

enum

desiredLandAndDevelopmentSubType

string

enum

Allowed:

desiredLeisureHospitalitySubType

string

enum

desiredRetailSubType

string

enum

Allowed:

desiredOtherSubType

string

enum

companyName

string | null

applicantRole

string

enum

Allowed:

sizeMinSqFt

int32 | null

sizeMaxSqFt

int32 | null

budgetMin

double | null

budgetMax

double | null

budgetFrequency

string

enum

Allowed:

targetOccupationDate

date | null

dateReceivedOverride

date-time | null

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

application/json

text/json

201The enquiry was created

400The body is missing, fails validation, names a property the team cannot reach, or omits a required teamId

401Missing or invalid API key, or the key is not bound to a team, client, or network

403The supplied teamId is outside the API key's scope