Create CrmOpportunityHistory

POST

api

crm

crmopportunityhistories

curl --request POST \
  --url https://spaces.nexudus.com/api/crm/crmopportunityhistories \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "NewCrmBoardColumnId": 123
}
'

import requests

url = "https://spaces.nexudus.com/api/crm/crmopportunityhistories"

payload = { "NewCrmBoardColumnId": 123 }
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({NewCrmBoardColumnId: 123})
};

fetch('https://spaces.nexudus.com/api/crm/crmopportunityhistories', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

A CrmOpportunityHistory records a single stage transition for a CRM opportunity. Each time an opportunity moves from one CRM stage to another, a history entry is created capturing the previous stage, the new stage, when the move happened, and which admin user triggered it. Use this entity to audit the movement of opportunities across a CRM board over time. The History tab on an opportunity in the Nexudus UI displays these records.

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 CrmOpportunityHistory-Create role.

Request Body

Required Fields

integer

required

CRM stage the opportunity moved to.

Optional Fields

integer

The opportunity this history entry belongs to.

integer

CRM stage the opportunity moved from (null for the initial placement).

string

When the opportunity entered the previous stage.

string

When the opportunity left the previous stage and entered the new one.

integer

Admin user who triggered the stage transition (null if moved automatically).

Code Examples

curl -X POST \
  "https://spaces.nexudus.com/api/crm/crmopportunityhistories" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "NewCrmBoardColumnId": 0
}'

const response = await fetch(
  'https://spaces.nexudus.com/api/crm/crmopportunityhistories',
  {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      NewCrmBoardColumnId: 0
    })
  }
);

const data = await response.json();

import requests

response = requests.post(
    'https://spaces.nexudus.com/api/crm/crmopportunityhistories',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'NewCrmBoardColumnId': 0
    }
)

data = response.json()

Response

200

integer

HTTP status code. 200 on success.

string

A human-readable message confirming the creation.

object

Contains the Id of the newly created record.

boolean

true if the crmopportunityhistory was created successfully.

array

null on success.

Example Response

{
  "Status": 200,
  "Message": "CrmOpportunityHistory was successfully created.",
  "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

string

A summary of the validation error(s), in the format PropertyName: error message.

any

null on validation failure.

object[]

Array of validation errors.

Show child attributes

any

The value that was submitted for the field, or null if missing.

string

The validation error message.

string

The name of the property that failed validation.

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
}

Update CrmOpportunityHistoryUpdate an existing CrmOpportunityHistory record.

Create CrmOpportunityHistory

curl --request POST \
  --url https://spaces.nexudus.com/api/crm/crmopportunityhistories \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "NewCrmBoardColumnId": 123
}
'

import requests

url = "https://spaces.nexudus.com/api/crm/crmopportunityhistories"

payload = { "NewCrmBoardColumnId": 123 }
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({NewCrmBoardColumnId: 123})
};

fetch('https://spaces.nexudus.com/api/crm/crmopportunityhistories', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400

​Authentication

​Request Body

​Required Fields

​Optional Fields

​Code Examples

​Response

​200

​400

Authentication

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400