Opportunities API
PUT/api/v1/opportunities/{id}
Product availabilityAlgaPSA

Update opportunity

Updates editable opportunity fields. status, stage, client_id, and the next-action mirror columns may be echoed back unchanged but never reassigned here: changing them answers 400 naming the dedicated endpoint.

RBAC · opportunities

Path parameters

idstring <uuid>Required
Opportunity UUID from opportunities.opportunity_id.

Request body

Content type: application/json · schema UpdateOpportunityBodyV1

client_idstring <uuid>
contact_idstring <uuid>Nullable
titlestring
min length 1
opportunity_typestring
Enum: new_logoexpansionrenewalproject
owner_idstring <uuid>
confidencestring
default "medium"
Enum: lowmediumhighcommitted
mrr_centsinteger
default 0 · ≥ 0
nrr_centsinteger
default 0 · ≥ 0
hardware_centsinteger
default 0 · ≥ 0
currency_codestring
min length 3 · max length 3
expected_close_datestringNullable
pattern /^\d{4}-\d{2}-\d{2}$/
generator_keystringNullable
Enum: renewaltm_conversionwhitespaceasset_aginginbound-lead
generator_contextobjectNullable
suggestion_idstring <uuid>Nullable
stagestring
Enum: identifiedqualifiedassessmentproposedverbalwonlost
statusstring
Enum: openwonlost
next_actionstringNullable
min length 1
next_action_duestring <date-time>Nullable

Response body

Success response 200 · schema OpportunityApiSuccessV1

dataobjectRequired
metaobject

Response codes

200
Operation succeeded.
400
Validation or request parsing failure.
401
API key missing or invalid.
403
RBAC denied for the opportunities resource action.
404
Opportunity or nested resource not found.
409
Opportunity state conflicts with the requested operation.
500
Unexpected controller or service failure.