> 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 Prospect: Knock POST https://api.propexo.com/crm/v1/prospects/knock Content-Type: application/json Create Prospect: Knock Reference: https://docs.propexo.com/api-reference/knock/prospects/create-prospect-knock ## 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 _crm_v1_prospects_knock_post_input. - `integration_id` (string, required) — The Propexo unique identifier for the integration - `community_id` (string, required) — The Propexo unique identifier for the community - `attribution_id` (string, required) — The Propexo unique identifier for the attribution - `agent_id` (string, optional) — The Propexo unique identifier for the agent - `email_1` (string, optional) — The primary email address associated with the prospect. This field and/or the phone_1 field are required - `phone_1` (string, optional) — Primary phone number associated with the prospect. This field and/or the email_1 field are required - `first_name` (string, optional) — The first name associated with the prospect - `last_name` (string, optional) — The last name associated with the prospect - `address_1` (string, optional) — The first address line associated with the prospect - `city` (string, optional) — The city associated with the prospect - `state` (string, optional) — The state associated with the prospect - `zip` (string, optional) — The zip code associated with the prospect - `move_in_date` (CrmV1ProspectsKnockPostInputMoveInDate, optional) — The move-in date associated with the prospect - `number_of_occupants` (integer, optional) — The number of occupants living in the unit - `lease_term_in_months` (integer, optional) — The amount of months for the lease term - `rent_minimum_in_cents` (integer, optional) — The minimum rent of the prospect - `rent_maximum_in_cents` (integer, optional) — The maximum rent of the prospect - `notes` (string, optional) — Notes associated with the prospect - `desired_num_bedrooms` (list of integer, optional) — The number of bedrooms associated with the prospect. 0 represents a studio unit. 3 represents three or more bedrooms. - `pets` (list of enum, optional) — A list of pets related to the prospect - Allowed values: `SMALL_DOG`, `LARGE_DOG`, `CAT` - `subscribe` (boolean, optional, default: true) — Whether or not to subscribe the prospect to automated Knock messaging. Verify with your customer that they have legal consent to send email messages to this customer - `first_contact_type` (enum, optional) — The type of initial contact with the prospect - Allowed values: `CALL`, `CHAT`, `EMAIL`, `FACEBOOK`, `FORM`, `INTERNET`, `KNOCK_SCHEDULE`, `SMS`, `WALK_IN` ## Response ### 200 Successful response - `meta` (CrmV1ProspectsKnockPostOutputMeta, required) - `result` (CrmV1ProspectsKnockPostOutputResult, required) ## Errors ### 400 Bad Request Error Bad Request - `error` (ErrorResponseError, required) ## Types ### CrmV1ProspectsKnockPostInputMoveInDate The move-in date associated with the prospect ### CrmV1ProspectsKnockPostOutputMeta - `job_id` (string, required) ### CrmV1ProspectsKnockPostOutputResult - `integration_id` (string, required) — The Propexo unique identifier for the integration - `community_id` (string, required) — The Propexo unique identifier for the community - `attribution_id` (string, required) — The Propexo unique identifier for the attribution - `agent_id` (string, required, nullable) — The Propexo unique identifier for the agent - `email_1` (string, required, nullable) — The primary email address associated with the prospect. This field and/or the phone_1 field are required - `phone_1` (string, required, nullable) — Primary phone number associated with the prospect. This field and/or the email_1 field are required - `first_name` (string, required, nullable) — The first name associated with the prospect - `last_name` (string, required, nullable) — The last name associated with the prospect - `address_1` (string, required, nullable) — The first address line associated with the prospect - `city` (string, required, nullable) — The city associated with the prospect - `state` (string, required, nullable) — The state associated with the prospect - `zip` (string, required, nullable) — The zip code associated with the prospect - `move_in_date` (CrmV1ProspectsKnockPostOutputResultMoveInDate, required, nullable) — The move-in date associated with the prospect - `number_of_occupants` (integer, required, nullable) — The number of occupants living in the unit - `lease_term_in_months` (integer, required, nullable) — The amount of months for the lease term - `rent_minimum_in_cents` (integer, required, nullable) — The minimum rent of the prospect - `rent_maximum_in_cents` (integer, required, nullable) — The maximum rent of the prospect - `notes` (string, required, nullable) — Notes associated with the prospect - `desired_num_bedrooms` (list of integer, required, nullable) - `pets` (list of enum, required, nullable) - Allowed values: `SMALL_DOG`, `LARGE_DOG`, `CAT` - `first_contact_type` (enum, required) — The type of initial contact with the prospect - Allowed values: `CALL`, `CHAT`, `EMAIL`, `FACEBOOK`, `FORM`, `INTERNET`, `KNOCK_SCHEDULE`, `SMS`, `WALK_IN` - `subscribe` (boolean, optional, default: true) — Whether or not to subscribe the prospect to automated Knock messaging. Verify with your customer that they have legal consent to send email messages to this customer ### ErrorResponseError - `code` (string, required) - `message` (string, required) - `details` (map from string to any, optional) ### CrmV1ProspectsKnockPostOutputResultMoveInDate The move-in date associated with the prospect ## Examples **Request** ```json { "integration_id": "intg_9f8b7c6d5e4a3b2c1d0e", "community_id": "comm_1234567890abcdef", "attribution_id": "attr_abcdef1234567890" } ``` **Response** ```json { "meta": { "job_id": "job_20240615_abcdef123456" }, "result": { "integration_id": "intg_9f8b7c6d5e4a3b2c1d0e", "community_id": "comm_1234567890abcdef", "attribution_id": "attr_abcdef1234567890", "agent_id": "agent_0987654321fedcba", "email_1": "jane.doe@example.com", "phone_1": "+14155552671", "first_name": "Jane", "last_name": "Doe", "address_1": "123 Maple Street", "city": "Springfield", "state": "IL", "zip": "62704", "move_in_date": "2024-09-01T00:00:00Z", "number_of_occupants": 2, "lease_term_in_months": 12, "rent_minimum_in_cents": 120000, "rent_maximum_in_cents": 150000, "notes": "Interested in a pet-friendly unit with parking included.", "desired_num_bedrooms": [ 1, 2 ], "pets": [ "SMALL_DOG", "CAT" ], "first_contact_type": "CALL", "subscribe": true } } ``` **SDK Code** ```python import requests url = "https://api.propexo.com/crm/v1/prospects/knock" payload = { "integration_id": "intg_9f8b7c6d5e4a3b2c1d0e", "community_id": "comm_1234567890abcdef", "attribution_id": "attr_abcdef1234567890" } 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/crm/v1/prospects/knock'; const options = { method: 'POST', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"integration_id":"intg_9f8b7c6d5e4a3b2c1d0e","community_id":"comm_1234567890abcdef","attribution_id":"attr_abcdef1234567890"}' }; 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/crm/v1/prospects/knock" payload := strings.NewReader("{\n \"integration_id\": \"intg_9f8b7c6d5e4a3b2c1d0e\",\n \"community_id\": \"comm_1234567890abcdef\",\n \"attribution_id\": \"attr_abcdef1234567890\"\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/crm/v1/prospects/knock") 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\": \"intg_9f8b7c6d5e4a3b2c1d0e\",\n \"community_id\": \"comm_1234567890abcdef\",\n \"attribution_id\": \"attr_abcdef1234567890\"\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/crm/v1/prospects/knock") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"integration_id\": \"intg_9f8b7c6d5e4a3b2c1d0e\",\n \"community_id\": \"comm_1234567890abcdef\",\n \"attribution_id\": \"attr_abcdef1234567890\"\n}") .asString(); ``` ```php request('POST', 'https://api.propexo.com/crm/v1/prospects/knock', [ 'body' => '{ "integration_id": "intg_9f8b7c6d5e4a3b2c1d0e", "community_id": "comm_1234567890abcdef", "attribution_id": "attr_abcdef1234567890" }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.propexo.com/crm/v1/prospects/knock"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"integration_id\": \"intg_9f8b7c6d5e4a3b2c1d0e\",\n \"community_id\": \"comm_1234567890abcdef\",\n \"attribution_id\": \"attr_abcdef1234567890\"\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [ "integration_id": "intg_9f8b7c6d5e4a3b2c1d0e", "community_id": "comm_1234567890abcdef", "attribution_id": "attr_abcdef1234567890" ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.propexo.com/crm/v1/prospects/knock")! 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() ```