Public API Reference (Beta)OpportunitiesCore

Update an opportunity

Partially updates a sales opportunity. Only fields present in the request body are modified; omitted fields are left unchanged. Requires the Manage My Opportunities permission (if assigned as a sales rep) or Manage Any Opportunities (for any opportunity).

Authentication

X-Brightmove-Company-ApiKeystring
BrightMove Company Api Key
X-Brightmove-User-ApiKeystring
BrightMove User Api Key

Path parameters

guidstringRequired
Stable public identifier of the opportunity

Request

This endpoint expects an object.
namestringOptional
Name of the opportunity.
clientGuidstringOptional

GUID of the client (company) to associate with this opportunity.

stageNamestringOptional
Stage name exactly as returned by the GET endpoint. Must match an existing stage configured for your company.
typeNamestringOptional
Opportunity type name exactly as returned by the GET endpoint. Must match an existing type configured for your company.
descriptionstringOptional
Detailed description of the opportunity and its objectives.
opportunityValuedoubleOptional
Estimated total deal value in USD.
closeProbabilitydoubleOptional
Estimated probability of closing this opportunity, expressed as a percentage from 0 to 100.
leadSourceNamestringOptional
Lead source name exactly as returned by the GET endpoint. Must match an existing lead source configured for your company.

Response

Opportunity updated and returned