> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.propexo.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.propexo.com/_mcp/server. # Create Lead: Entrata POST https://api.propexo.com/v1/leads/entrata/ Content-Type: application/json Create Lead: Entrata| Method | | --------------- | | leads/sendLeads |Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. Reference: https://docs.propexo.com/api-reference/entrata/leads/create-lead-entrata ## Authentication - `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer `, where token is your auth token. ## Servers - `https://api.propexo.com` (Production, default) - `https://api.sandbox.propexo.com` (Sandbox) ## Request ### Body (application/json) This endpoint expects a _v1_leads_entrata__post_input. - `integration_id` (string, required) — The Propexo unique identifier for the integration - `property_id` (string, required) — The Propexo unique identifier for the property - `lead_source_id` (string, required) — The Propexo unique identifier for the lead source - `first_name` (string, required) — The first name associated with the lead - `last_name` (string, required) — The last name associated with the lead - `unit_id` (string, optional) — The Propexo unique identifier for the unit - `lease_period_id` (string, optional) — The Propexo unique identifier for the lease period - `employee_id` (string, optional) — The Propexo unique identifier for the employee - `phone_1` (string, optional) — Primary phone number associated with the lead. This is often required, but this is configurable to be optional by the property manager. Make sure this is being provided if it's configured to be required for your customer. - `phone_1_type` (enum, optional) — Type of the primary phone number - Allowed values: `FAX`, `HOME`, `MOBILE`, `OTHER`, `WORK` - `middle_name` (string, optional) — The middle name associated with the lead - `phone_2` (string, optional) — Secondary phone number associated with the lead - `phone_2_type` (enum, optional) — Type of the secondary phone number - Allowed values: `FAX`, `HOME`, `MOBILE`, `OTHER`, `WORK` - `email_1` (string, optional) — The primary email address associated with the lead - `address_1` (string, optional) — The first address line associated with the lead - `address_2` (string, optional) — The second address line associated with the lead - `city` (string, optional) — The city associated with the lead - `state` (string, optional) — The state associated with the lead - `zip` (string, optional) — The zip code associated with the lead - `target_move_in_date` (string, optional) — The move-in date associated with the lead - `desired_max_rent_in_cents` (integer, optional) — The maximum rent cost the lead is looking to pay, in cents - `desired_min_rent_in_cents` (integer, optional) — The minimum rent cost the lead is looking to pay, in cents - `desired_num_bathrooms` (double, optional) — The desired number of bathrooms - `desired_num_bedrooms` (double, optional) — The desired number of bedrooms - `number_of_occupants` (integer, optional) — The number of occupants living in the unit - `notes` (string, optional) — Notes associated with the lead - `events` (list of V1LeadsEntrataPostInputEventsItems, optional, deprecated) — DEPRECATED: Please use /events endpoints to write events. Array of events associated with this lead ## Response ### 200 Successful response - `meta` (V1LeadsEntrataPostOutputMeta, required) - `result` (V1LeadsEntrataPostOutputResult, required) ## Errors ### 400 Bad Request Error Bad Request - `error` (ErrorResponseError, required) ## Types ### V1LeadsEntrataPostInputEventsItems - `x_type_id` (string, required) — The PMS id for the event type. - `unit_id` (string, optional) — The Propexo unique identifier for the unit - `x_leasing_agent_id` (string, optional) — The PMS id for the leasing agent. - `x_sub_type_id` (string, optional) — The PMS id for the event sub type. - `x_result_id` (string, optional) — The PMS id for the event result. - `event_datetime` (string, optional) — The date and time that the event occured. - `appointment_datetime` (string, optional) — The date and time that the appointment will occur. Required if using appointment type. - `time_from` (string, optional) - `time_to` (string, optional) - `notes` (string, optional) — General notes about the event. - `title` (string, optional) — Title for the event. - `reasons_for_event` (string, optional) — The reason the event occurred. ### V1LeadsEntrataPostOutputMeta - `job_id` (string, required) ### V1LeadsEntrataPostOutputResult - `integration_id` (string, required) — The Propexo unique identifier for the integration - `property_id` (string, required) — The Propexo unique identifier for the property - `lead_source_id` (string, required) — The Propexo unique identifier for the lead source - `unit_id` (string, required, nullable) — The Propexo unique identifier for the unit - `lease_period_id` (string, required, nullable) — The Propexo unique identifier for the lease period - `employee_id` (string, required, nullable) — The Propexo unique identifier for the employee - `first_name` (string, required) — The first name associated with the lead - `last_name` (string, required) — The last name associated with the lead - `phone_1` (string, required, nullable) — Primary phone number associated with the lead. This is often required, but this is configurable to be optional by the property manager. Make sure this is being provided if it's configured to be required for your customer. - `phone_1_type` (enum, required) — Type of the primary phone number - Allowed values: `FAX`, `HOME`, `MOBILE`, `OTHER`, `WORK` - `middle_name` (string, required, nullable) — The middle name associated with the lead - `phone_2` (string, required, nullable) — Secondary phone number associated with the lead - `phone_2_type` (enum, required) — Type of the secondary phone number - Allowed values: `FAX`, `HOME`, `MOBILE`, `OTHER`, `WORK` - `email_1` (string, required, nullable) — The primary email address associated with the lead - `address_1` (string, required, nullable) — The first address line associated with the lead - `address_2` (string, required, nullable) — The second address line associated with the lead - `city` (string, required, nullable) — The city associated with the lead - `state` (string, required, nullable) — The state associated with the lead - `zip` (string, required, nullable) — The zip code associated with the lead - `target_move_in_date` (string, required, nullable) — The move-in date associated with the lead - `desired_max_rent_in_cents` (integer, required, nullable) — The maximum rent cost the lead is looking to pay, in cents - `desired_min_rent_in_cents` (integer, required, nullable) — The minimum rent cost the lead is looking to pay, in cents - `desired_num_bathrooms` (double, required, nullable) — The desired number of bathrooms - `desired_num_bedrooms` (double, required, nullable) — The desired number of bedrooms - `number_of_occupants` (integer, required, nullable) — The number of occupants living in the unit - `notes` (string, required, nullable) — Notes associated with the lead - `events` (list of V1LeadsEntrataPostOutputResultEventsItems, required, nullable) ### ErrorResponseError - `code` (string, required) - `message` (string, required) - `details` (map from string to any, optional) ### V1LeadsEntrataPostOutputResultEventsItems - `x_type_id` (string, required) - `unit_id` (string, optional) — The Propexo unique identifier for the unit - `x_leasing_agent_id` (string, optional) — The PMS id for the leasing agent. - `x_sub_type_id` (string, optional) — The PMS id for the event sub type. - `x_result_id` (string, optional) — The PMS id for the event result. - `event_datetime` (string, optional) — The date and time that the event occured. - `appointment_datetime` (string, optional) — The date and time that the appointment will occur. Required if using appointment type. - `time_from` (string, optional) - `time_to` (string, optional) - `notes` (string, optional) — General notes about the event. - `title` (string, optional) — Title for the event. - `reasons_for_event` (string, optional) — The reason the event occurred. ## Examples **Request** ```json { "integration_id": "int-987654321", "property_id": "prop-123456789", "lead_source_id": "leadsrc-456789123", "first_name": "Emily", "last_name": "Johnson" } ``` **Response** ```json { "meta": { "job_id": "job-20240615-001" }, "result": { "integration_id": "int-987654321", "property_id": "prop-123456789", "lead_source_id": "leadsrc-456789123", "unit_id": "unit-101", "lease_period_id": "lease-2024Q3", "employee_id": "emp-5551234", "first_name": "Emily", "last_name": "Johnson", "phone_1": "+1-555-123-4567", "phone_1_type": "MOBILE", "middle_name": "Grace", "phone_2": "+1-555-765-4321", "phone_2_type": "WORK", "email_1": "emily.johnson@example.com", "address_1": "123 Maple Street", "address_2": "Apt 4B", "city": "Springfield", "state": "IL", "zip": "62704", "target_move_in_date": "2024-07-01T10:00:00Z", "desired_max_rent_in_cents": 150000, "desired_min_rent_in_cents": 120000, "desired_num_bathrooms": 2, "desired_num_bedrooms": 3, "number_of_occupants": 2, "notes": "Interested in a pet-friendly unit with parking.", "events": [ { "x_type_id": "evt-001", "unit_id": "unit-101", "x_leasing_agent_id": "agent-789", "x_sub_type_id": "subtype-05", "x_result_id": "result-03", "event_datetime": "2024-06-20T14:00:00Z", "appointment_datetime": "2024-06-22T16:00:00Z", "time_from": "16:00", "time_to": "17:00", "notes": "Scheduled tour of the unit.", "title": "Unit Tour Appointment", "reasons_for_event": "Lead requested a viewing before application." } ] } } ``` **SDK Code** ```python import requests url = "https://api.propexo.com/v1/leads/entrata/" payload = { "integration_id": "int-987654321", "property_id": "prop-123456789", "lead_source_id": "leadsrc-456789123", "first_name": "Emily", "last_name": "Johnson" } headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.propexo.com/v1/leads/entrata/'; const options = { method: 'POST', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"integration_id":"int-987654321","property_id":"prop-123456789","lead_source_id":"leadsrc-456789123","first_name":"Emily","last_name":"Johnson"}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.propexo.com/v1/leads/entrata/" payload := strings.NewReader("{\n \"integration_id\": \"int-987654321\",\n \"property_id\": \"prop-123456789\",\n \"lead_source_id\": \"leadsrc-456789123\",\n \"first_name\": \"Emily\",\n \"last_name\": \"Johnson\"\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.propexo.com/v1/leads/entrata/") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{\n \"integration_id\": \"int-987654321\",\n \"property_id\": \"prop-123456789\",\n \"lead_source_id\": \"leadsrc-456789123\",\n \"first_name\": \"Emily\",\n \"last_name\": \"Johnson\"\n}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://api.propexo.com/v1/leads/entrata/") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"integration_id\": \"int-987654321\",\n \"property_id\": \"prop-123456789\",\n \"lead_source_id\": \"leadsrc-456789123\",\n \"first_name\": \"Emily\",\n \"last_name\": \"Johnson\"\n}") .asString(); ``` ```php request('POST', 'https://api.propexo.com/v1/leads/entrata/', [ 'body' => '{ "integration_id": "int-987654321", "property_id": "prop-123456789", "lead_source_id": "leadsrc-456789123", "first_name": "Emily", "last_name": "Johnson" }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.propexo.com/v1/leads/entrata/"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"integration_id\": \"int-987654321\",\n \"property_id\": \"prop-123456789\",\n \"lead_source_id\": \"leadsrc-456789123\",\n \"first_name\": \"Emily\",\n \"last_name\": \"Johnson\"\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [ "integration_id": "int-987654321", "property_id": "prop-123456789", "lead_source_id": "leadsrc-456789123", "first_name": "Emily", "last_name": "Johnson" ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.propexo.com/v1/leads/entrata/")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```