Skip to main content
POST
/
api
/
crm
/
crmboards
Create CrmBoard
curl --request POST \
  --url https://spaces.nexudus.com/api/crm/crmboards \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "BusinessId": 123,
  "Name": "<string>"
}
'
{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}
A CrmBoard represents a Customer Relationship Management board used to automate processes and communication with current and potential customers. Each board represents a common sales or operational scenario (e.g. onboarding new members, offboarding cancellations, or managing a sales pipeline). Boards contain CRM stages (CrmBoardColumn entity) that define the steps opportunities move through, and each stage can trigger actions such as sending message macros or creating task lists. Nexudus provides built-in templates (e.g. sales pipeline with or without digital signature) that can be used as-is or customised by adding, removing, or editing stages. Boards can also be built from scratch.

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

​
Request Body

​
Required Fields

​
BusinessId
integer
required
Business Id.
​
Name
string
required
Board name identifying the CRM process (e.g. ‘Sales Pipeline’, ‘Onboarding’).

​
Optional Fields

​
Archived
boolean
Whether the board is archived. Archived boards are hidden from the active board list but retain their data.

​
Code Examples

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

​
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 crmboard was created successfully.
​
Errors
array
null on success.
Example Response
{
  "Status": 200,
  "Message": "CrmBoard 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
}