PropelBiz34leadsOpportunitiesCRUD

Create Opportunity

View as Markdown
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`.

Headers

{{tenant_key_name}}stringOptional

Request

This endpoint expects a multipart form.
namestringRequired

Required: Opportunity name - string max 255

originstringRequired

Required: OpportunityOrigin enum case (e.g. DIRECT, REFERRAL, INBOUND_CALL)

customer_idstringRequired

Required: Customer UUID

descriptionstringRequired

Optional: free-text description

expected_valuestringRequired

Optional: numeric >= 0

contacts[0][role]stringRequired

Required-with contacts[]: OpportunityContactRole enum (e.g. DECISION_MAKER, INFLUENCER)

customer_location_idstringRequired

Required: Customer location UUID

contacts[0][is_primary]stringRequired

Optional: bool - at most one primary across contacts[]

contacts[0][customer_contact_id]stringRequired

Required-with contacts[]: Customer contact UUID

Response

Successful response