Updates an existing CrmOpportunity record. You must include the Id of the record to update along with all required fields.
Authentication
This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header.
The authenticated user must be a full unrestricted administrator or have the CrmOpportunity-Edit role.
Enums
Value Name 1 Web 2 Phone 4 Webinar 5 Referral 6 PrintAdvert 7 PurchasedList 8 WordOfMouth 9 DirectEmail 10 EmailMarketing 11 Broker 12 PropertyAgent 13 Facebook 14 Linkedin 15 Instagram 16 Twitter 17 HubbleHq 18 LiquidSpace 19 GoogleSearch 20 SpacePool 21 InstantOffices 22 OfficeFreedom 23 FlexiOffices 24 Workthere 25 Kontor 26 Valve 98 OtherSocialNetwork 99 Other
eCrmOpportunityLossReason
Value Name 1 Timing 2 Need 3 PoorQualification 4 Price 5 Feature 6 LostMomentum 7 Competition 8 ContractTerm 9 Duplicate 10 Waitlist 11 NotReturningCalls 12 LackOfFacilities 13 NoPetPolicy 14 NoRightFit 15 Location 16 Entrance 17 Errors 18 Archived 19 SearchOnHold 20 RelocationOnHold 99 Other
eCrmOpportunityStatus — Status values
Value Name 1 InProgress 2 Won 3 Lost
Request Body
Required Fields
The Id of the CrmOpportunity record to update.
Opportunity status: InProgress (still active), Won (led to a sale), or Lost (did not lead to a sale).
Display order of the opportunity within its current stage.
Optional Fields
Optional tag to identify this opportunity, useful when the same customer appears in multiple boards.
Opportunity type used to categorise and auto-populate general notes from a template.
Admin user responsible for managing this opportunity.
Customer who referred this opportunity.
External agent or broker who brought this opportunity.
General notes visible to admins when viewing the opportunity. Auto-populated from the opportunity type template if a type is assigned.
Whether the opportunity has been completed (won or lost).
Follow-up date for the opportunity.
Expected revenue if the opportunity is won.
Whether a follow-up reminder has been sent for this opportunity.
How the opportunity was acquired (e.g. Web, Phone, Referral, Broker, GoogleSearch). See eCrmOpportunitySource? enum above.
Why the opportunity was lost (e.g. Price, Competition, Location). Only relevant when Status is Lost. See eCrmOpportunityLossReason? enum above.
Date when the opportunity was marked as won.
Date when the opportunity was marked as lost.
UTM source parameter captured from the URL the opportunity used.
UTM medium parameter captured from the URL the opportunity used.
UTM campaign parameter captured from the URL the opportunity used.
UTM content parameter captured from the URL the opportunity used.
UTM term parameter captured from the URL the opportunity used.
Code Examples
curl -X PUT \
"https://spaces.nexudus.com/api/crm/crmopportunities" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"CrmBoardColumnId": 0,
"CoworkerId": null,
"Status": 0,
"Position": 0,
"Id": 87654321
}'
Response
200
HTTP status code. 200 on success.
A human-readable message confirming the update.
Contains the Id of the updated record.
true if the crmopportunity was updated successfully.
{
"Status" : 200 ,
"Message" : "CrmOpportunity was successfully updated." ,
"Value" : {
"Id" : 87654321
},
"OpenInDialog" : false ,
"OpenInWindow" : false ,
"RedirectURL" : null ,
"JavaScript" : null ,
"UpdatedOn" : "2025-01-15T10:30:00Z" ,
"UpdatedBy" : "admin@example.com" ,
"Errors" : null ,
"WasSuccessful" : true
}
400
A summary of the validation error(s), in the format PropertyName: error message.
null on validation failure.
Array of validation errors. The value that was submitted for the field, or null if missing.
The validation error message.
The name of the property that failed validation.
false when the request fails validation.
{
"Message" : "Status: is a required field" ,
"Value" : null ,
"Errors" : [
{
"AttemptedValue" : null ,
"Message" : "is a required field" ,
"PropertyName" : "Status"
}
],
"WasSuccessful" : false
}