Skip to main content
POST
/
api
/
crm
/
crmboardcolumns
Create CrmBoardColumn
curl --request POST \
  --url https://spaces.nexudus.com/api/crm/crmboardcolumns \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "CrmBoardId": 123,
  "Name": "<string>",
  "Position": 123
}
'
{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://learn.nexudus.com/llms.txt

Use this file to discover all available pages before exploring further.

A CrmBoardColumn represents a stage (step) within a CRM board. In the Nexudus UI these are called CRM Stages. Each stage has two main components:
  • Auto assignment — controls which opportunities are automatically added to this stage. Enable one of the boolean triggers (e.g. TourRequests, SignUps, Cancellations, ProductPurchased) to auto-populate the stage when the corresponding event occurs.
  • Auto actions — controls what happens when an opportunity reaches this stage. Assign a message macro (CannedResponseId), a task list (TaskListId), and/or an account action (ActivateAccount, DeactivateAccount, DeleteAccount, ConfirmTour, WinOpportunity, LoseOpportunity).
Stages are ordered by Position within their parent board. Opportunities move through stages either automatically (when conditions are met) or manually.

​
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 CrmBoardColumn-Create role.

​
Request Body

​
Required Fields

​
CrmBoardId
integer
required
Crm Board Id.
​
Name
string
required
Stage name (e.g. ‘Contract Signature’, ‘Keys Handout’, ‘Office Tour’).
​
Position
integer
required
Display order of this stage within the board (0-based).

​
Optional Fields

​
TourRequests
boolean
Auto-assign: add anyone completing a tour request form to this stage.
​
ToursConfirmed
boolean
Auto-assign: add anyone confirming a tour to this stage.
​
TourCompleted
boolean
Auto-assign: add anyone completing a tour to this stage.
​
WinOpportunity
boolean
Auto-action: mark opportunity as won when added to this stage.
​
LoseOpportunity
boolean
Auto-action: mark opportunity as lost when added to this stage.
​
SignUps
boolean
Auto-assign: add anyone completing a sign-up form to this stage.
​
Bookings
boolean
Auto-assign: add anyone placing a booking to this stage.
​
Cancellations
boolean
Auto-assign: add anyone cancelling their contract to this stage.
​
ProposalsSent
boolean
Auto-assign: add anyone sent a proposal to this stage.
​
ProposalsAccepted
boolean
Auto-assign: add anyone accepting a proposal to this stage.
​
DocumentsSigned
boolean
Auto-assign: add anyone e-signing a document to this stage.
​
EventRegistrations
boolean
Auto-assign: add anyone registering for an event to this stage.
​
ContactMessages
boolean
Auto-assign: add anyone sending a contact message to this stage.
​
CannedResponseId
integer
Auto-action: message macro to send when an opportunity reaches this stage.
​
TaskListId
integer
Auto-action: task list to create when an opportunity reaches this stage.
​
UseTaskListAsResponsible
boolean
Assign the task list’s own responsible users instead of the opportunity owner.
​
ActivateAccount
boolean
Auto-action: activate the account of opportunities added to this stage.
​
DeleteAccount
boolean
Auto-action: permanently delete the account and all customer details of opportunities added to this stage.
​
DeactivateAccount
boolean
Auto-action: deactivate the account of opportunities added to this stage.
​
ConfirmTour
boolean
Auto-action: confirm the tour of opportunities added to this stage.
​
ProductPurchased
boolean
Auto-assign: add anyone purchasing a specific product to this stage. Requires Products list.
​
Products
integer[]
Product IDs that trigger auto-assignment when ProductPurchased is enabled.
​
ResourceBooked
boolean
Auto-assign: add anyone placing a booking for a specific resource to this stage. Requires Resources list.
​
Resources
integer[]
Resource IDs that trigger auto-assignment when ResourceBooked is enabled.
​
EventCheckins
boolean
Auto-assign: add any event attendee who checks in for an event to this stage.

​
Code Examples

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

​
Response

​
200

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

​
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
}