> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.itspropel.com/llms.txt. > For full documentation content, see https://docs.itspropel.com/llms-full.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.itspropel.com/_mcp/server. # Create Lead POST https://leads Content-Type: multipart/form-data Create a Lead with optional `contacts[]` and `addresses[]` payload. **Identity rule (PRD §10.1):** - `customer_type=commercial` → `business_name` required. - `customer_type=residential` → at least one `contacts[]` item with first_name + last_name. **Primary-flag invariants:** at most one `is_primary=true` per contacts[] / addresses[]. Reference: https://docs.itspropel.com/propel-biz/34-leads/leads/34-leads-leads-crud/create-lead ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: PropelBiz version: 1.0.0 paths: /leads: post: operationId: create-lead summary: Create Lead description: >- Create a Lead with optional `contacts[]` and `addresses[]` payload. **Identity rule (PRD §10.1):** - `customer_type=commercial` → `business_name` required. - `customer_type=residential` → at least one `contacts[]` item with first_name + last_name. **Primary-flag invariants:** at most one `is_primary=true` per contacts[] / addresses[]. tags: - >- subpackage_34Leads.subpackage_34Leads/leads.subpackage_34Leads/leads/34LeadsLeadsCrud parameters: - name: '{{tenant_key_name}}' in: header required: false schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: >- #/components/schemas/34 Leads_Leads_34 Leads > Leads > CRUD_Create Lead_Response_200 requestBody: content: multipart/form-data: schema: type: object properties: customer_type: type: string description: 'Required: residential|commercial' lead_source_id: type: string description: 'Required: Lead source UUID' inquiry_summary: type: string description: 'Optional: Free-text inquiry description' addresses[0][city]: type: string description: Required when addresses[] present. String max 120. contacts[0][email]: type: string description: 'Optional: contact email. Valid email max 255.' contacts[0][phone]: type: string description: 'Optional: contact phone. String max 64.' addresses[0][state]: type: string description: Required when addresses[] present. String max 120. contacts[0][last_name]: type: string description: >- Conditional: pairs with contacts[0][first_name]. String max 120. contacts[0][first_name]: type: string description: >- Conditional: required for residential leads when no other contact provides one. String max 120. contacts[0][is_primary]: type: string description: >- Optional: bool - at most one primary per contacts[]. Defaults to first row when none flagged. addresses[0][is_primary]: type: string description: >- Optional: bool - at most one primary per addresses[]. Defaults to first row when none flagged. preferred_contact_method: type: string description: 'Optional: phone|email|sms' addresses[0][postal_code]: type: string description: Required when addresses[] present. String max 32. addresses[0][address_line_1]: type: string description: Required when addresses[] present. String max 255. required: - customer_type - lead_source_id - inquiry_summary - addresses[0][city] - contacts[0][email] - contacts[0][phone] - addresses[0][state] - contacts[0][last_name] - contacts[0][first_name] - contacts[0][is_primary] - addresses[0][is_primary] - preferred_contact_method - addresses[0][postal_code] - addresses[0][address_line_1] servers: - url: https:/ components: schemas: 34 Leads_Leads_34 Leads > Leads > CRUD_Create Lead_Response_200: type: object properties: {} description: Empty response body title: 34 Leads_Leads_34 Leads > Leads > CRUD_Create Lead_Response_200 ``` ## SDK Code Examples ```python import requests url = "https://https/leads" payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"customer_type\"\r\n\r\nresidential\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"lead_source_id\"\r\n\r\n3fa85f64-5717-4562-b3fc-2c963f66afa6\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"inquiry_summary\"\r\n\r\nInterested in upgrading home internet service to fiber optic.\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"addresses[0][city]\"\r\n\r\nSan Francisco\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"contacts[0][email]\"\r\n\r\njane.doe@example.com\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"contacts[0][phone]\"\r\n\r\n+1-415-555-1234\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"addresses[0][state]\"\r\n\r\nCalifornia\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"contacts[0][last_name]\"\r\n\r\nDoe\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"contacts[0][first_name]\"\r\n\r\nJane\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"contacts[0][is_primary]\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"addresses[0][is_primary]\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"preferred_contact_method\"\r\n\r\nemail\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"addresses[0][postal_code]\"\r\n\r\n94107\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"addresses[0][address_line_1]\"\r\n\r\n123 Market St\r\n-----011000010111000001101001--\r\n" headers = { "{{tenant_key_name}}": "{{tenant_key_value1}}|{{tenant_key_value2}}", "Content-Type": "multipart/form-data; boundary=---011000010111000001101001" } response = requests.post(url, data=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://https/leads'; const form = new FormData(); form.append('customer_type', 'residential'); form.append('lead_source_id', '3fa85f64-5717-4562-b3fc-2c963f66afa6'); form.append('inquiry_summary', 'Interested in upgrading home internet service to fiber optic.'); form.append('addresses[0][city]', 'San Francisco'); form.append('contacts[0][email]', 'jane.doe@example.com'); form.append('contacts[0][phone]', '+1-415-555-1234'); form.append('addresses[0][state]', 'California'); form.append('contacts[0][last_name]', 'Doe'); form.append('contacts[0][first_name]', 'Jane'); form.append('contacts[0][is_primary]', 'true'); form.append('addresses[0][is_primary]', 'true'); form.append('preferred_contact_method', 'email'); form.append('addresses[0][postal_code]', '94107'); form.append('addresses[0][address_line_1]', '123 Market St'); const options = { method: 'POST', headers: {'{{tenant_key_name}}': '{{tenant_key_value1}}|{{tenant_key_value2}}'} }; options.body = form; 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://https/leads" payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"customer_type\"\r\n\r\nresidential\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"lead_source_id\"\r\n\r\n3fa85f64-5717-4562-b3fc-2c963f66afa6\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"inquiry_summary\"\r\n\r\nInterested in upgrading home internet service to fiber optic.\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"addresses[0][city]\"\r\n\r\nSan Francisco\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"contacts[0][email]\"\r\n\r\njane.doe@example.com\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"contacts[0][phone]\"\r\n\r\n+1-415-555-1234\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"addresses[0][state]\"\r\n\r\nCalifornia\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"contacts[0][last_name]\"\r\n\r\nDoe\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"contacts[0][first_name]\"\r\n\r\nJane\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"contacts[0][is_primary]\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"addresses[0][is_primary]\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"preferred_contact_method\"\r\n\r\nemail\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"addresses[0][postal_code]\"\r\n\r\n94107\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"addresses[0][address_line_1]\"\r\n\r\n123 Market St\r\n-----011000010111000001101001--\r\n") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("{{tenant_key_name}}", "{{tenant_key_value1}}|{{tenant_key_value2}}") 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://https/leads") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["{{tenant_key_name}}"] = '{{tenant_key_value1}}|{{tenant_key_value2}}' request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"customer_type\"\r\n\r\nresidential\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"lead_source_id\"\r\n\r\n3fa85f64-5717-4562-b3fc-2c963f66afa6\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"inquiry_summary\"\r\n\r\nInterested in upgrading home internet service to fiber optic.\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"addresses[0][city]\"\r\n\r\nSan Francisco\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"contacts[0][email]\"\r\n\r\njane.doe@example.com\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"contacts[0][phone]\"\r\n\r\n+1-415-555-1234\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"addresses[0][state]\"\r\n\r\nCalifornia\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"contacts[0][last_name]\"\r\n\r\nDoe\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"contacts[0][first_name]\"\r\n\r\nJane\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"contacts[0][is_primary]\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"addresses[0][is_primary]\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"preferred_contact_method\"\r\n\r\nemail\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"addresses[0][postal_code]\"\r\n\r\n94107\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"addresses[0][address_line_1]\"\r\n\r\n123 Market St\r\n-----011000010111000001101001--\r\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://https/leads") .header("{{tenant_key_name}}", "{{tenant_key_value1}}|{{tenant_key_value2}}") .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"customer_type\"\r\n\r\nresidential\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"lead_source_id\"\r\n\r\n3fa85f64-5717-4562-b3fc-2c963f66afa6\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"inquiry_summary\"\r\n\r\nInterested in upgrading home internet service to fiber optic.\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"addresses[0][city]\"\r\n\r\nSan Francisco\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"contacts[0][email]\"\r\n\r\njane.doe@example.com\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"contacts[0][phone]\"\r\n\r\n+1-415-555-1234\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"addresses[0][state]\"\r\n\r\nCalifornia\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"contacts[0][last_name]\"\r\n\r\nDoe\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"contacts[0][first_name]\"\r\n\r\nJane\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"contacts[0][is_primary]\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"addresses[0][is_primary]\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"preferred_contact_method\"\r\n\r\nemail\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"addresses[0][postal_code]\"\r\n\r\n94107\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"addresses[0][address_line_1]\"\r\n\r\n123 Market St\r\n-----011000010111000001101001--\r\n") .asString(); ``` ```php request('POST', 'https://https/leads', [ 'multipart' => [ [ 'name' => 'customer_type', 'contents' => 'residential' ], [ 'name' => 'lead_source_id', 'contents' => '3fa85f64-5717-4562-b3fc-2c963f66afa6' ], [ 'name' => 'inquiry_summary', 'contents' => 'Interested in upgrading home internet service to fiber optic.' ], [ 'name' => 'addresses[0][city]', 'contents' => 'San Francisco' ], [ 'name' => 'contacts[0][email]', 'contents' => 'jane.doe@example.com' ], [ 'name' => 'contacts[0][phone]', 'contents' => '+1-415-555-1234' ], [ 'name' => 'addresses[0][state]', 'contents' => 'California' ], [ 'name' => 'contacts[0][last_name]', 'contents' => 'Doe' ], [ 'name' => 'contacts[0][first_name]', 'contents' => 'Jane' ], [ 'name' => 'contacts[0][is_primary]', 'contents' => 'true' ], [ 'name' => 'addresses[0][is_primary]', 'contents' => 'true' ], [ 'name' => 'preferred_contact_method', 'contents' => 'email' ], [ 'name' => 'addresses[0][postal_code]', 'contents' => '94107' ], [ 'name' => 'addresses[0][address_line_1]', 'contents' => '123 Market St' ] ] 'headers' => [ '{{tenant_key_name}}' => '{{tenant_key_value1}}|{{tenant_key_value2}}', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://https/leads"); var request = new RestRequest(Method.POST); request.AddHeader("{{tenant_key_name}}", "{{tenant_key_value1}}|{{tenant_key_value2}}"); request.AddParameter("undefined", "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"customer_type\"\r\n\r\nresidential\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"lead_source_id\"\r\n\r\n3fa85f64-5717-4562-b3fc-2c963f66afa6\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"inquiry_summary\"\r\n\r\nInterested in upgrading home internet service to fiber optic.\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"addresses[0][city]\"\r\n\r\nSan Francisco\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"contacts[0][email]\"\r\n\r\njane.doe@example.com\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"contacts[0][phone]\"\r\n\r\n+1-415-555-1234\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"addresses[0][state]\"\r\n\r\nCalifornia\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"contacts[0][last_name]\"\r\n\r\nDoe\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"contacts[0][first_name]\"\r\n\r\nJane\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"contacts[0][is_primary]\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"addresses[0][is_primary]\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"preferred_contact_method\"\r\n\r\nemail\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"addresses[0][postal_code]\"\r\n\r\n94107\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"addresses[0][address_line_1]\"\r\n\r\n123 Market St\r\n-----011000010111000001101001--\r\n", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = ["{{tenant_key_name}}": "{{tenant_key_value1}}|{{tenant_key_value2}}"] let parameters = [ [ "name": "customer_type", "value": "residential" ], [ "name": "lead_source_id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ], [ "name": "inquiry_summary", "value": "Interested in upgrading home internet service to fiber optic." ], [ "name": "addresses[0][city]", "value": "San Francisco" ], [ "name": "contacts[0][email]", "value": "jane.doe@example.com" ], [ "name": "contacts[0][phone]", "value": "+1-415-555-1234" ], [ "name": "addresses[0][state]", "value": "California" ], [ "name": "contacts[0][last_name]", "value": "Doe" ], [ "name": "contacts[0][first_name]", "value": "Jane" ], [ "name": "contacts[0][is_primary]", "value": "true" ], [ "name": "addresses[0][is_primary]", "value": "true" ], [ "name": "preferred_contact_method", "value": "email" ], [ "name": "addresses[0][postal_code]", "value": "94107" ], [ "name": "addresses[0][address_line_1]", "value": "123 Market St" ] ] let boundary = "---011000010111000001101001" var body = "" var error: NSError? = nil for param in parameters { let paramName = param["name"]! body += "--\(boundary)\r\n" body += "Content-Disposition:form-data; name=\"\(paramName)\"" if let filename = param["fileName"] { let contentType = param["content-type"]! let fileContent = String(contentsOfFile: filename, encoding: String.Encoding.utf8) if (error != nil) { print(error as Any) } body += "; filename=\"\(filename)\"\r\n" body += "Content-Type: \(contentType)\r\n\r\n" body += fileContent } else if let paramValue = param["value"] { body += "\r\n\r\n\(paramValue)" } } let request = NSMutableURLRequest(url: NSURL(string: "https://https/leads")! 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() ```