ZRM Docs
API ReferenceOpportunity

opportunity.create

Type: Mutation · Auth: Workspace-aware

Input

FieldTypeRequiredDefaultDescription
customerIdstringYesID of the associated customer
primaryContactIdstringNoID of the associated primary contact
siteIdstringNoID of the associated site
titlestringYesTitle
stageenum(lead, qualified, survey, proposal, negotiation, won, lost)Yes"lead"Stage
pipelineTypeenum(new_construction, retrofit, service_agreement, expansion, other)YesPipeline type
sourceenum(referral, website, cold_call, existing_customer, partner, trade_show, portal_request, other)NoSource
estimatedValuenumberNoEstimated value
expectedCloseDatestring.date-timeNoExpected close date
probabilityintegerNoProbability
solutionFamiliesstring[]NoSolution families
scopeSummarystringNoScope summary
competitorNotesstringNoCompetitor notes
winLossReasonstringNoWin loss reason
nextStepDescriptionstringNoNext step description
nextStepDatestring.date-timeNoNext step date
bidDueDatestring.date-timeNoBid due date
budgetConfirmedbooleanYesfalseBudget confirmed
priorityenum(low, medium, high, urgent)NoPriority
lostReasonCategoryenum(price, timing, competitor, scope_mismatch, no_decision, relationship, other)NoLost reason category
technicalRequirementsstringNoTechnical requirements
ownerUserIdstringNoID of the associated owner user
workspaceIdstringNoID of the associated workspace
visibilityModeenum(global, workspace_local, shared)Yes"workspace_local"Visibility mode

Example

{
  "customerId": "550e8400-e29b-41d4-a716-446655440000",
  "primaryContactId": "550e8400-e29b-41d4-a716-446655440000",
  "siteId": "550e8400-e29b-41d4-a716-446655440000",
  "title": "Example Title",
  "stage": "lead",
  "pipelineType": "new_construction",
  "budgetConfirmed": false,
  "visibilityMode": "global"
}

On this page