Skip to main content
POST
/
api
/
sys
/
validationrules
Create ValidationRule
curl --request POST \
  --url https://spaces.nexudus.com/api/sys/validationrules \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "BusinessId": 123,
  "Name": "<string>",
  "RecordType": 123,
  "Formula": "<string>"
}
'
{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}
A ValidationRule defines a custom business rule that validates data before it is saved. Rules can be applied to various record types (coworkers, bookings, contracts, visitors, etc.) and enforce custom conditions beyond the standard field validations.

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

​
Enums

ValueName
1Coworker
2Booking
4CoworkerContract
5Visitor
6CoworkerProduct
7ProposalContract
8CoworkerInvoice
9Teams
10EventAttendees

​
Request Body

​
Required Fields

​
BusinessId
integer
required
ID of the business linked to this record.
​
Name
string
required
The name value for this validation rule.
​
RecordType
integer
required
The record type value for this validation rule.
​
Formula
string
required
The formula value for this validation rule.

​
Optional Fields

​
Active
boolean
Whether this validation rule is currently active.
​
Description
string
Free-text description of this validation rule.
​
ErrorMessage
string
The error message value for this validation rule.

​
Code Examples

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

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