Create ValidationRule

Create a new ValidationRule record.

POST /api/sys/validationrules

Create ValidationRule

cURL

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>"
}
'

200

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

A validation rule is a location-scoped custom expression evaluated when selected records are created or updated; a false result blocks the save with its configured error message.

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

eValidationRuleEntity — RecordType values

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

Request Body

Required Fields

BusinessId · integer · required

ID of the location that owns this rule; a rule on a network location is also evaluated for records in its child locations.

Name · string · required

Required internal name for this rule; it is returned as the failure message when ErrorMessage is null.

RecordType · integer · required

Record type this rule evaluates: Coworker (customer), Booking, CoworkerContract, Visitor, CoworkerProduct, ProposalContract, CoworkerInvoice, Teams, or EventAttendees.

Formula · string · required

Required Flee expression that returns true to allow the record and false to reject it; use record, isCreate, isUpdate, user, and the available CustomFunctions as evaluation context.

Optional Fields

Active · boolean

Whether this rule is evaluated when a matching record is created or updated; only active rules are selected for evaluation.

Description · string

Optional internal notes explaining this rule; not shown to customers.

ErrorMessage · string

Message returned when Formula evaluates to false; when null, the rule Name is returned instead.

Code Examples

cURL

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": "[e-mail]",
  "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.

Show child attributes

AttemptedValue · any

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

Message · string

The validation error message.

PropertyName · string

The name of the property that failed validation.

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
}