Create ValidationRule

POST

api

sys

validationrules

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

import requests

url = "https://spaces.nexudus.com/api/sys/validationrules"

payload = {
    "BusinessId": 123,
    "Name": "<string>",
    "RecordType": 123,
    "Formula": "<string>"
}
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({BusinessId: 123, Name: '<string>', RecordType: 123, Formula: '<string>'})
};

fetch('https://spaces.nexudus.com/api/sys/validationrules', 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 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

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

integer

required

ID of the business linked to this record.

string

required

The name value for this validation rule.

integer

required

The record type value for this validation rule.

string

required

The formula value for this validation rule.

Optional Fields

boolean

Whether this validation rule is currently active.

string

Free-text description of this validation rule.

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

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/validationrules',
  {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      BusinessId: 0,
      Name: '',
      RecordType: 0,
      Formula: ''
    })
  }
);

const data = await response.json();

import requests

response = requests.post(
    'https://spaces.nexudus.com/api/sys/validationrules',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'BusinessId': 0,
        'Name': '',
        'RecordType': 0,
        'Formula': ''
    }
)

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 validationrule was created successfully.

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

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 ValidationRuleUpdate an existing ValidationRule record.

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

import requests

url = "https://spaces.nexudus.com/api/sys/validationrules"

payload = {
    "BusinessId": 123,
    "Name": "<string>",
    "RecordType": 123,
    "Formula": "<string>"
}
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({BusinessId: 123, Name: '<string>', RecordType: 123, Formula: '<string>'})
};

fetch('https://spaces.nexudus.com/api/sys/validationrules', 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

Enums

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400

​Authentication

​Enums

​Request Body

​Required Fields

​Optional Fields

​Code Examples

​Response

​200

​400

Authentication

Enums

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400