leadIdstringrequired
Example:lead_71ab
Request deletion
Carries out a data subject’s rights request immediately. Personal
fields are permanently removed; activity that must be retained for
tax purposes remains pseudonymized.
post
Path Parameters
Body
application/json
Body
application/json
reasonstringrequired
Allowed values:data_subject_requestretention_expiredduplicate
sourcestring
Example:email dated 2026-08-18
Response
202 application/json
Response
202 application/json
Deletion initiated
lead_idstring
anonymized_atstring(date-time)
post/leads/{leadId}/deletion
Authentication
Path Parameters
Body
{
"reason": "data_subject_request"
}
202 application/json
Inquiries
List inquiries
get
Query Parameters
property_idstring
Example:prop_8f2c1a
statusstring
Allowed values:newscoredinviteddeclinedclosed
Example:scored
Response
200 application/json
Response
200 application/json
Results list
dataarray[object]
Show Child Parameters
pageobject
Cursor-based pagination.
Show Child Parameters
get/inquiries
Authentication
Query Parameters
200 application/json
Record an inquiry
Typically called from the contact form on the agency’s own website.
post
Body
application/json
Body
application/json
property_idstringrequired
Example:prop_8f2c1a
lead_idstringrequired
Example:lead_71ab
messagestring
<= 2000 characters
channelstring
Allowed values:websiteportalphonetrade_fair
Response
201 application/json
Response
201 application/json
Recorded
Inquiry
idstring
Example:inq_5c02
property_idstring
Example:prop_8f2c1a
lead_idstring
Example:lead_71ab
statusstring
Allowed values:newscoredinviteddeclinedclosed
Example:scored
channelstring
Example:website
messagestring
Example:Hello, is the apartment still available? We would like to view it.
received_atstring(date-time)
Example:2026-08-19T17:05:31Z
post/inquiries
Authentication
Body
{
"property_id": "prop_8f2c1a",
"lead_id": "lead_71ab"
}
201 application/json