API DOCUMENTATION
addMatching (POST)
Adds the given matching and returns the id.
- customer_type (integer, required): The customer type. The customer types can be found in the section Customer Types.
- matching_title (string, optional): The matching’s title.
- matching_reference (string, optional): The matching’s reference.
- min_price (decimal, optional): The matching’s minimum price.
- max_price (decimal, optional): The matching’s maximum price.
- min_sqm_area (integer, optional): The matching’s minimum square meters area.
- max_sqm_area (integer, optional): The matching’s maximum square meters area.
- num_bathrooms (integer, optional): The matching’s bathroom number.
- num_bedrooms (integer, optional): The matching’s bedroom number.
- elevator (boolean, optional): Boolean that indicates if an elevator is wanted in the matching.
- balcony (boolean, optional): Boolean that indicates if a balcony is wanted in the matching.
- terrace (boolean, optional): Boolean that indicates if a terrace is wanted in the matching.
- communitary_area (boolean, optional): Boolean that indicates if a community area is wanted in the matching.
- concierge (boolean, optional): Boolean that indicates if a concierge is wanted in the matching.
- swimming_pool (boolean, optional): Boolean that indicates if a swimming pool is wanted in the matching.
- parking (boolean, optional): Boolean that indicates if a parking is wanted in the matching.
- garden (boolean, optional): Boolean that indicates if a garden is wanted in the matching.
- 24_hour_surveillance (boolean, optional): Boolean that indicates if 24 hour surveillance is wanted in the matching.
- disabled_access (boolean, optional): Boolean that indicates if disabled access is wanted in the matching.
- furnished (boolean, optional): Boolean that indicates if the property is furnished in the matching.
- storage_room (boolean, optional): Boolean that indicates if an storage room is wanted in the matching.
- exterior_interior (boolean, optional): Boolean that indicates the preference for exterior (0) or interior (1) in the matching.
- air_conditioning (boolean, optional): Boolean that indicates if air conditioning is wanted in the matching.
- heating (boolean, optional): Boolean that indicates if heating is wanted in the matching.
- pets_allowed (boolean, optional): Boolean that indicates if the pets are allowed in the matching.
- id_portal_interest (integer, optional): The matching’s portal interest id. The customer types can be found in the section Portals.
- loading_docks (boolean, optional): Boolean that indicates if loading docks is wanted in the matching.
- num_parkings (integer, optional): The matching’s number of parkings.
- description (string, optional): The matching’s description.
- min_above_ground_area (integer, optional): The minimum above ground area.
- max_above_ground_area (integer, optional): The maximum above ground area.
- min_profitability (integer, optional): The minimum profitability.
- max_profitability (integer, optional): The minimum profitability.
- min_profitability_percentage (integer, optional): The minimum profitability percentage.
- max_profitability_percentage (integer, optional): The maximum profitability percentage.
- min_buildable_area_per_floor (integer, optional): The minimum buildable area per floor.
- max_buildable_area_per_floor (integer, optional): The maximum buildable area per floor..
- min_buildable_area (integer, optional): The minimum buildable area.
- max_buildable_area (integer, optional): The maximum buildable area.
- num_entities (integer, optional): The number of entities.
- max_occupancy_percentage (integer, optional):The maximum occupancy percentage.
- urbanized (boolean, optional): Boolean that indicates if is urbanized.
- smoke_vent (boolean, optional): Boolean that indicates if there’s smoke vent.
- id_activity (string, optional): The activity id. The activities can be found with the call getActivities.
- transfer (boolean, optional): Boolean that indicates if it’s a transfer.
- show_profitabilty (boolean, optional): Boolean used to show the profitability.
- id_status (integer, required): The matching’s status id. The matching statuses can be found in the section Matching Status.
- id_tracking (string, optional): The matching’s tracking id. The trackings can be found with the call getMatchingTrackings.
- cancellation_date (date, optional): The matching’s cancellation date.
- cancellation_reason (string, optional): The matching’s cancellation reason.
- min_plot_size (integer, optional): The minimum plot size.
- max_plot_size (integer, optional): The maximum plot size.
- crane_bridges (integer, optional): The number of crane bridges.
- min_price_per_sqm (integer, optional): The minimum price per square meter.
- max_price_per_sqm (integer, optional): The maximum price per square meter.
- id_origin (string, required): The matching’s origin id. The customer types can be found with the call getPropertyOrigins.
- id_assigned_agent (string, optional): The matching’s assigned agent id. The agents can be found using the call getUsers.
- id_creator (string, optional): The matching’s creator id. The creators can be found using the call getUsers.
- maximum_date (date, optional): The matching’s maximum date.
- reassigned (boolean, optional): Boolean that indicates if it’s a reassigned matching.
- registration_date (date, required): The matching’s registration date.
- customer_name (string, required): The matching’s customer name.
- customer_surnames (string, optional): The matching’s customer surnames.
- nif_cif (string, optional): The matching’s customer NIF/CIF.
- phone_number (string, optional): The matching’s customer phone number.
- whatsapp (boolean, optional): Boolean that indicates if the matching’s customer has whatsapp.
- language (string, optional): The matching’s customer language.
- email (string, optional): The matching’s customer email.
- id_property_type (integer, optional): The matching’s property type id. The property types can be found in the section Property Types.
- property_subtypes (array of integers, optional): Array of property subtypes ids, which are integers. The property subtypes can be found in the section Property Subtypes.
- zonifications(array of strings, optional): Array of zonifications ids, which are strings. The zonifications can be found with the call getMatchingZonifications.
- districts (array of strings, optional): Array of districts ids, which are strings. The districts can be found in the section getMatchingDistricts.
Request example
CURL:
curl --location 'https://movin.cloud/api/real-estate/add-matching' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer SECRETOKEN'
Body example:
{
"customer_type": 1,
"matching_title": "Test matching postman",
"matching_reference": "REF-1",
"min_price": 1.99,
"max_price": 122123.12,
"min_sqm_area": 1,
"max_sqm_area": 10000,
"num_bathrooms": 1,
"num_bedrooms": 1,
"elevator": 0,
"balcony": 0,
"terrace": 0,
"communitary_area": 0,
"concierge": 0,
"swimming_pool": 0,
"parking": 0,
"garden": 0,
"24_hour_surveillance": 0,
"disabled_access": 0,
"furnished": 0,
"storage_room": 0,
"available": 0,
"exterior_interior": 0,
"air_conditioning": 0,
"heating": 0,
"pets_allowed": 0,
"id_portal_interest": 1,
"loading_docks": 0,
"num_parkings": 0,
"description": "Descripcion test postman",
"min_above_ground_area": 1,
"max_above_ground_area": 10000,
"min_profitability": 1,
"max_profitability": 10000,
"min_profitability_percentage": 1,
"max_profitability_percentage": 10000000,
"min_buildable_area_per_floor": 1,
"max_buildable_area_per_floor": 100000,
"min_buildable_area": 1,
"max_buildable_area": 100000,
"num_entities": 1,
"max_occupancy_percentage": 100000,
"urbanized": 0,
"smoke_vent": 0,
"restoration": 0,
"id_activity": “M&56k934$”,
"implemented": 0,
"transfer": 0,
"show_profitabilty": 0,
"id_status": 1,
"id_tracking": “M&Ujhk934$”,
"cancellation_date": null,
"cancellation_reason": null,
"min_plot_size": 0,
"max_plot_size": 1000,
"crane_bridges": 0,
"building": 0,
"min_price_per_sqm": 1,
"max_price_per_sqm": 1000,
"id_origin": “MG4/>34$”,
"id_assigned_agent": “MG4i87gd$”,
"id_creator": “MG43eh534$”,
"maximum_date": null,
"reassigned": null,
"registration_date": "2024-07-08",
"customer_name": "Pep",
"customer_surnames": "Ferrer Ventura",
"nif_cif": "87473278F",
"phone_number": "79879878791121",
"whatsapp": 1,
"language": "ca",
"email": "kajdasa12@sdsd1.sd",
"id_property_type": 1,
"property_subtypes": [1, 2],
"zonifications": ["MjQkMzQ1Njk=", "MjQkMzQ1Njg="],
"districts": ["MjQkMzQ1Njg=", "MjQkMzQ1Njk="]
}
Response Example
{
“data”: [
“id_matching”: “MG43g54r934$”
, "id_customer": "MFgs53&fsw2T"
]
}