> 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 Opportunity POST https://leads/opportunities Content-Type: multipart/form-data Create an Opportunity, optionally with initial `contacts[]` pivot rows. **Required:** `customer_id`, `customer_location_id`, `name`, `origin` (OpportunityOrigin enum). **Optional:** `description`, `original_lead_id`, `original_lead_source_id`, `opportunity_stage_id` (service falls back to `is_initial`), `assigned_user_id`, `expected_value` (numeric ≥ 0), `probability_override` (0-100), `expected_close_date`, `service_category_id`. Reference: https://docs.itspropel.com/propel-biz/34-leads/opportunities/34-leads-opportunities-crud/create-opportunity ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: PropelBiz version: 1.0.0 paths: /leads/opportunities: post: operationId: create-opportunity summary: Create Opportunity description: >- Create an Opportunity, optionally with initial `contacts[]` pivot rows. **Required:** `customer_id`, `customer_location_id`, `name`, `origin` (OpportunityOrigin enum). **Optional:** `description`, `original_lead_id`, `original_lead_source_id`, `opportunity_stage_id` (service falls back to `is_initial`), `assigned_user_id`, `expected_value` (numeric ≥ 0), `probability_override` (0-100), `expected_close_date`, `service_category_id`. tags: - >- subpackage_34Leads.subpackage_34Leads/opportunities.subpackage_34Leads/opportunities/34LeadsOpportunitiesCrud 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_Opportunities_34 Leads > Opportunities > CRUD_Create Opportunity_Response_200 requestBody: content: multipart/form-data: schema: type: object properties: name: type: string description: 'Required: Opportunity name - string max 255' origin: type: string description: >- Required: OpportunityOrigin enum case (e.g. DIRECT, REFERRAL, INBOUND_CALL) customer_id: type: string description: 'Required: Customer UUID' description: type: string description: 'Optional: free-text description' expected_value: type: string description: 'Optional: numeric >= 0' contacts[0][role]: type: string description: >- Required-with contacts[]: OpportunityContactRole enum (e.g. DECISION_MAKER, INFLUENCER) customer_location_id: type: string description: 'Required: Customer location UUID' contacts[0][is_primary]: type: string description: 'Optional: bool - at most one primary across contacts[]' contacts[0][customer_contact_id]: type: string description: 'Required-with contacts[]: Customer contact UUID' required: - name - origin - customer_id - description - expected_value - contacts[0][role] - customer_location_id - contacts[0][is_primary] - contacts[0][customer_contact_id] servers: - url: https:/ components: schemas: 34 Leads_Opportunities_34 Leads > Opportunities > CRUD_Create Opportunity_Response_200: type: object properties: {} description: Empty response body title: >- 34 Leads_Opportunities_34 Leads > Opportunities > CRUD_Create Opportunity_Response_200 ``` ## SDK Code Examples ```python import requests url = "https://https/leads/opportunities" payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\nNew Corporate Partnership\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"origin\"\r\n\r\nREFERRAL\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"customer_id\"\r\n\r\na3f1c9d2-4b6e-4f8a-9d3e-2b7f1a9c8d5e\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"description\"\r\n\r\nOpportunity to expand services with existing client through new product line.\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"expected_value\"\r\n\r\n150000\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"contacts[0][role]\"\r\n\r\nDECISION_MAKER\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"customer_location_id\"\r\n\r\nd9e8f7a6-b5c4-4d3e-8f2a-1b0c9d8e7f6a\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=\"contacts[0][customer_contact_id]\"\r\n\r\nf1e2d3c4-b5a6-7d8e-9f0a-b1c2d3e4f5a6\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/opportunities'; const form = new FormData(); form.append('name', 'New Corporate Partnership'); form.append('origin', 'REFERRAL'); form.append('customer_id', 'a3f1c9d2-4b6e-4f8a-9d3e-2b7f1a9c8d5e'); form.append('description', 'Opportunity to expand services with existing client through new product line.'); form.append('expected_value', '150000'); form.append('contacts[0][role]', 'DECISION_MAKER'); form.append('customer_location_id', 'd9e8f7a6-b5c4-4d3e-8f2a-1b0c9d8e7f6a'); form.append('contacts[0][is_primary]', 'true'); form.append('contacts[0][customer_contact_id]', 'f1e2d3c4-b5a6-7d8e-9f0a-b1c2d3e4f5a6'); 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/opportunities" payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\nNew Corporate Partnership\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"origin\"\r\n\r\nREFERRAL\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"customer_id\"\r\n\r\na3f1c9d2-4b6e-4f8a-9d3e-2b7f1a9c8d5e\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"description\"\r\n\r\nOpportunity to expand services with existing client through new product line.\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"expected_value\"\r\n\r\n150000\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"contacts[0][role]\"\r\n\r\nDECISION_MAKER\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"customer_location_id\"\r\n\r\nd9e8f7a6-b5c4-4d3e-8f2a-1b0c9d8e7f6a\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=\"contacts[0][customer_contact_id]\"\r\n\r\nf1e2d3c4-b5a6-7d8e-9f0a-b1c2d3e4f5a6\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/opportunities") 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=\"name\"\r\n\r\nNew Corporate Partnership\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"origin\"\r\n\r\nREFERRAL\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"customer_id\"\r\n\r\na3f1c9d2-4b6e-4f8a-9d3e-2b7f1a9c8d5e\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"description\"\r\n\r\nOpportunity to expand services with existing client through new product line.\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"expected_value\"\r\n\r\n150000\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"contacts[0][role]\"\r\n\r\nDECISION_MAKER\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"customer_location_id\"\r\n\r\nd9e8f7a6-b5c4-4d3e-8f2a-1b0c9d8e7f6a\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=\"contacts[0][customer_contact_id]\"\r\n\r\nf1e2d3c4-b5a6-7d8e-9f0a-b1c2d3e4f5a6\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/opportunities") .header("{{tenant_key_name}}", "{{tenant_key_value1}}|{{tenant_key_value2}}") .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\nNew Corporate Partnership\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"origin\"\r\n\r\nREFERRAL\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"customer_id\"\r\n\r\na3f1c9d2-4b6e-4f8a-9d3e-2b7f1a9c8d5e\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"description\"\r\n\r\nOpportunity to expand services with existing client through new product line.\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"expected_value\"\r\n\r\n150000\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"contacts[0][role]\"\r\n\r\nDECISION_MAKER\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"customer_location_id\"\r\n\r\nd9e8f7a6-b5c4-4d3e-8f2a-1b0c9d8e7f6a\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=\"contacts[0][customer_contact_id]\"\r\n\r\nf1e2d3c4-b5a6-7d8e-9f0a-b1c2d3e4f5a6\r\n-----011000010111000001101001--\r\n") .asString(); ``` ```php request('POST', 'https://https/leads/opportunities', [ 'multipart' => [ [ 'name' => 'name', 'contents' => 'New Corporate Partnership' ], [ 'name' => 'origin', 'contents' => 'REFERRAL' ], [ 'name' => 'customer_id', 'contents' => 'a3f1c9d2-4b6e-4f8a-9d3e-2b7f1a9c8d5e' ], [ 'name' => 'description', 'contents' => 'Opportunity to expand services with existing client through new product line.' ], [ 'name' => 'expected_value', 'contents' => '150000' ], [ 'name' => 'contacts[0][role]', 'contents' => 'DECISION_MAKER' ], [ 'name' => 'customer_location_id', 'contents' => 'd9e8f7a6-b5c4-4d3e-8f2a-1b0c9d8e7f6a' ], [ 'name' => 'contacts[0][is_primary]', 'contents' => 'true' ], [ 'name' => 'contacts[0][customer_contact_id]', 'contents' => 'f1e2d3c4-b5a6-7d8e-9f0a-b1c2d3e4f5a6' ] ] 'headers' => [ '{{tenant_key_name}}' => '{{tenant_key_value1}}|{{tenant_key_value2}}', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://https/leads/opportunities"); 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=\"name\"\r\n\r\nNew Corporate Partnership\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"origin\"\r\n\r\nREFERRAL\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"customer_id\"\r\n\r\na3f1c9d2-4b6e-4f8a-9d3e-2b7f1a9c8d5e\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"description\"\r\n\r\nOpportunity to expand services with existing client through new product line.\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"expected_value\"\r\n\r\n150000\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"contacts[0][role]\"\r\n\r\nDECISION_MAKER\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"customer_location_id\"\r\n\r\nd9e8f7a6-b5c4-4d3e-8f2a-1b0c9d8e7f6a\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=\"contacts[0][customer_contact_id]\"\r\n\r\nf1e2d3c4-b5a6-7d8e-9f0a-b1c2d3e4f5a6\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": "name", "value": "New Corporate Partnership" ], [ "name": "origin", "value": "REFERRAL" ], [ "name": "customer_id", "value": "a3f1c9d2-4b6e-4f8a-9d3e-2b7f1a9c8d5e" ], [ "name": "description", "value": "Opportunity to expand services with existing client through new product line." ], [ "name": "expected_value", "value": "150000" ], [ "name": "contacts[0][role]", "value": "DECISION_MAKER" ], [ "name": "customer_location_id", "value": "d9e8f7a6-b5c4-4d3e-8f2a-1b0c9d8e7f6a" ], [ "name": "contacts[0][is_primary]", "value": "true" ], [ "name": "contacts[0][customer_contact_id]", "value": "f1e2d3c4-b5a6-7d8e-9f0a-b1c2d3e4f5a6" ] ] 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/opportunities")! 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() ```