Skip to main content
PUT
/
api
/
crm
/
crmopportunities
{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}
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.

Request Body

Required Fields

Id
integer
required
The Id of the CrmOpportunity record to update.
CrmBoardColumnId
integer
required
Crm Board Column Id.
CoworkerId
integer
required
Coworker Id.
Position
integer
required
Position.

Optional Fields

Name
string
Name.
TeamId
integer
Team Id.
OpportunityTypeId
integer
Opportunity Type Id.
ResponsibleId
integer
Responsible Id.
ReferrerId
integer
Referrer Id.
AgentId
integer
Agent Id.
Notes
string
Notes.
Completed
boolean
Completed.
DueDate
string
Due Date.
Value
number
Value.
Reminded
boolean
Reminded.
LeadSource
integer
Lead Source. See eCrmOpportunitySource? enum above.
LossReason
integer
Loss Reason. See eCrmOpportunityLossReason? enum above.
Status
integer
Status. See eCrmOpportunityStatus enum above.
WonOn
string
Won On.
LostOn
string
Lost On.
UtmSource
string
Utm Source.
UtmMedium
string
Utm Medium.
UtmCampaign
string
Utm Campaign.
UtmContent
string
Utm Content.
UtmTerm
string
Utm Term.

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,
    "Position": 0,
    "Id": 87654321
}'

Response

200

Status
integer
HTTP status code. 200 on success.
Message
string
A human-readable message confirming the update.
Value
object
Contains the Id of the updated record.
WasSuccessful
boolean
true if the crmopportunity was updated successfully.
Errors
array
null on success.
Example Response
{
  "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

Message
string
A summary of the validation error(s), in the format PropertyName: error message.
Value
any
null on validation failure.
Errors
object[]
Array of validation errors.
WasSuccessful
boolean
false when the request fails validation.
Example Response
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}