Qualifications⚓︎

Danger

If a request to create a lead is sent and neither the lead nor the contact exists, we will create both.

Headers

Name	Value
Content-Type	`application/json`
user	`user-agent`

Listing Identification Fields

As Maxwork exports listings to other portals, one of the main types of identifications on the external portals is the public_reference.

Parameter	Description	Required
`Public_Reference`	The maxwork public reference of the listing (its exposed on all public portals), for Manual Leads you need to add the "None" value	True

Lead Information Fields

These parameters are used both to create leads and contacts

Parameter	Description	Required
`Sender_Name`	The name of the contact/lead.	True
`Sender_Email`	The email of contact/lead.	True
`Sender_Phone`	The phone number of the contact/lead.	True
`Message`	The message on the lead	True
`Lead_Status`	New, Contacted, Archived	True

Lead Qualification Fields

If these fields are provided, the lead will be moved to the qualification stage.

Parameter	Description	Required
`Internal_UserId`	The Internal User Is Optional, Is used to override the Lead Manager role for an Agency, If you want to set a Lead for example for Fizbot user, you should add your user Id	False
`Price_Min`	The minimum price.	False
`Price_Max`	The maximum price.	False
`Room_Min`	The minimum number of rooms.	False
`Room_Max`	The maximum number of rooms.	False
`Area_Min`	The minimum area of the listing.	False
`Area_Max`	The maximum area of the listing.	False
`LeadType_Id`	The lead type `Seller` or `Buyer` lead.	False
`Business_TypeId`	The type of qualification `Sale`, `Rent`	False
`Listing_ClassId`	The class of the listing `Residential` , `Commercial`	False
`External_LeadId`	Fizbot Id	False
`Listing_Attributes` *	`Parking_Space = 0`, `Lift = 1` ,`Swimming_Pool = 7`, `Balcony = 5`, `Terrace = 8`, `Storage = 11`, `Garden_Area = 9`, `Air_Conditioning = 51`	False
`Created_At`	The creationg date of the lead	False
`Lead_Status`	The lead status is one of the key parameters for changing the state or archiving a lead `New` `Contacted` `Archived`	False
`PropertyTypeId`	The type of the listing `//Residential` `[PublicClass(LeadPublicListingClass.Residential)] ManorHouse = 27` `[PublicClass(LeadPublicListingClass.Residential)] SmallMansion = 26` `[PublicClass(LeadPublicListingClass.Residential)] StorageRoom = 28` `[PublicClass(LeadPublicListingClass.Residential)] CondoApartment = 1` `[PublicClass(LeadPublicListingClass.Residential)] Duplex = 3` `[PublicClass(LeadPublicListingClass.Residential)] Studio = 5` `[PublicClass(LeadPublicListingClass.Residential)] Garage = 6` `[PublicClass(LeadPublicListingClass.Residential)] House = 11` `[PublicClass(LeadPublicListingClass.Residential)] Building = 12` `[PublicClass(LeadPublicListingClass.Residential)] Farm = 13` `[PublicClass(LeadPublicListingClass.Residential)] Land = 21` `[PublicClass(LeadPublicListingClass.Residential)] OthersResidential = 24` `//Commercial` `[PublicClass(LeadPublicListingClass.Commercial)] BusinessOffice = 4` `[PublicClass(LeadPublicListingClass.Commercial)] Homestead = 23` `[PublicClass(LeadPublicListingClass.Commercial)] Hotel = 7` `[PublicClass(LeadPublicListingClass.Commercial)] Industrial = 8` `[PublicClass(LeadPublicListingClass.Commercial)] Investment = 9` `[PublicClass(LeadPublicListingClass.Commercial)] Store = 10` `[PublicClass(LeadPublicListingClass.Commercial)] SaleBusiness = 15` `[PublicClass(LeadPublicListingClass.Commercial)] Warehouse = 20` `[PublicClass(LeadPublicListingClass.Commercial)] OthersCommercial = 25`	False

Warning

Listing Attributes can be sent as numbers or strings.

Create a new Qualification⚓︎

POST /listingexport/leads?token={token}

Body Example

{
  "Message": "I am interested on this listing.",
  "Sender_Name": "Test Case",
  "Sender_Email": "[email protected]",
  "Sender_Phone": "92687912",
  "Internal_UserId" : "524",
  "LeadTypeId": "1", // Seller = 1 or Buyer = 2
  "External_LeadId": "926879", //Your ID
  "Lead_Status": "New"
  "Business_TypeId": "Sale",
  "Listing_ClassId": "Residential",
  "Price_Min": "100000",
  "Price_Max": "500000",
  "Room_Min": "1",
  "Room_Max": "4",
  "Created_At": "2025-04-03T11:17:31.212Z",
  "Area_Min": "100",
  "Area_Max": "300",
  "Listing_Attributes": [
    "Parking_Space"
  ],
  "Property_Type": "ManorHouse",
  "Latitude": "0.90742",
  "Longitude": "-11.71016",
  "Expiration_Date": "2025-04-03T11:17:31.212Z",
  "Notes": "QLF Notes",
  "Floor": "1",
  "Total_Floor": "2"
}

Response

200400403

{
    "Message": "Data was successfully inserted!"
}

{
    "Message": "The following property was in the wrong format."
}

{

}