Create ResourceAccessRule - Nexudus Platform

POST

api

spaces

resourceaccessrules

Create ResourceAccessRule

curl --request POST \
  --url https://spaces.nexudus.com/api/spaces/resourceaccessrules \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "BusinessId": 123,
  "Name": "<string>",
  "AppliedResourcesCount": 123,
  "EvaluationOrder": 123,
  "CancellationFeeType": 123
}
'

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

A ResourceAccessRule defines additional booking policies and restrictions for one or more Resource(s) or for all resources in a location (Business), scoped by date/time, customer, team, plan, or other criteria. Rules are evaluated in EvaluationOrder and can optionally stop further evaluation when matched (StopEvaluationIfRuleIsMet). The booking-policy fields (BookInAdvanceLimit, LateBookingLimit, LateCancellationLimit, IntervalLimit, MaxBookingLength, MinBookingLength, NoReturnPolicy*, cancellation-fee fields, and repeat-booking limits) mirror those on Resource and carry the same semantics — they override the resource-level defaults when the rule matches. When BusinessId is set and Resources is empty, the rule applies to all resources in the business and its children (if any). When specific Resources are listed, the rule applies only to those resources.

Scope: who the rule applies to

OnlyForMembers / OnlyForContacts — quick toggles to limit the rule to members or contacts.
Tariffs — pricing plans this rule applies to. When set, the rule only fires for customers on one of these plans.
Teams — teams this rule applies to. When set, the rule only fires for members of one of these teams.
Courses — the rule applies only to customers who have completed one of these courses.
EventCategories — the rule applies only to customers who have attended (checked in to) an event in one of these categories.

Scope: who is allowed to book when the rule fires

AllowedTariffs — only customers on one of these plans are allowed to book when the rule applies to them.
AllowedTeams — only members of one of these teams are allowed to book when the rule applies to them.

List mutation helpers

For each list field (Tariffs, AllowedTariffs, Teams, AllowedTeams, Members, EventCategories, Courses) there are Added* and Removed* variants that append or remove entries on update without replacing the full list.

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 ResourceAccessRule-Create role.

Enums

eCancellationFeeType — CancellationFeeType values

Value	Name
0	None
1	Absolute
2	Percentage

Request Body

Required Fields

BusinessId

integer

required

ID of the business linked to this record.

Name

string

required

Rule name.

AppliedResourcesCount

integer

required

The applied resources count value for this resource access rule.

EvaluationOrder

integer

required

Order in which this rule is evaluated relative to other rules on the same resource. Lower values are evaluated first..

CancellationFeeType

integer

required

How the cancellation fee is calculated: Absolute (fixed amount) or Percentage (of booking cost).. Defaults to eCancellationFeeType.Absolute.

Optional Fields

Resources

integer[]

List of resources linked to this record.

Active

boolean

Whether this rule is currently active and evaluated during booking..

OnlyForContacts

boolean

When true, this rule applies only to contacts (non-member customers)..

ApplyRuleFrom

string

Date from which this rule starts being evaluated. Null means no start-date restriction..

ApplyRuleTo

string

Date after which this rule stops being evaluated. Null means no end-date restriction..

BookInAdvanceLimit

number

Maximum number of days in advance a booking can be made. Null means no limit..

LateBookingLimit

number

Minimum lead time (in minutes) required before a booking can start. Prevents last-minute bookings..

LateCancellationLimit

integer

Cut-off in minutes before the booking start time. Cancellations after this point are considered late and may incur a fee..

IntervalLimit

integer

Minimum interval (in minutes) between consecutive bookings on this resource, used as a buffer for setup or cleaning..

MaxBookingLength

integer

Maximum allowed duration for a single booking, in minutes..

MinBookingLength

integer

Minimum allowed duration for a single booking, in minutes..

NoReturnPolicy

integer

Cooldown in minutes: prevents the same user from booking this specific resource again within this window after their last booking ends..

NoReturnPolicyAllResources

integer

Cooldown in minutes: prevents the same user from booking any resource after booking this one, for the specified window..

NoReturnPolicyAllUsers

integer

Cooldown in minutes: prevents any user from booking this resource within the specified window after the previous booking ends..

RejectWithMessage

string

Message shown to the user when their booking is rejected by this rule..

OnlyForMembers

boolean

When true, this rule applies only to active members (coworkers with a plan)..

Tariffs

integer[]

List of tariffs linked to this record.

AllowedTariffs

integer[]

List of allowed tariffs linked to this record.

Members

integer[]

List of members linked to this record.

Teams

integer[]

List of teams linked to this record.

AllowedTeams

integer[]

List of allowed teams linked to this record.

EventCategories

integer[]

List of event categories linked to this record.

Courses

integer[]

List of courses linked to this record.

StopEvaluationIfRuleIsMet

boolean

When true, no further rules are evaluated after this one matches..

CancellationFeeProductId

integer

ID of the cancellation fee product linked to this record.

ChargeCancellationFee

boolean

When true, a fee is charged for late cancellations (past the LateCancellationLimit)..

CancellationFeeAmount

number

Fixed cancellation fee amount. Used when CancellationFeeType is Absolute..

CancellationFeePercentage

number

Cancellation fee as a percentage of the booking cost. Used when CancellationFeeType is Percentage..

RepeatBookingQuantityLimit

integer

Maximum number of occurrences allowed when creating a recurring booking under this rule..

RepeatBookingPeriodLimitInMonths

integer

Maximum time span (in months) over which a recurring booking series can extend under this rule..

Children

EligibleTimeSlots

object[]

Time slots defining when this rule applies (eligibility windows). The year, month and day component of FromTime/ToTime is always 1976-01-01.

Show child attributes

DayOfWeek

integer

required

The day of week value for this resource access rule eligible time slot.

FromTime

string

required

Start time.

ToTime

string

required

End time.

TimeSlots

object[]

The days and times the resources can be booked when this rule applies. The year, month and day component of FromTime/ToTime is always 1976-01-01.

Show child attributes

DayOfWeek

integer

required

The day of week value for this resource access rule time slot.

FromTime

string

required

Start time.

ToTime

string

required

End time.

Code Examples

curl -X POST \
  "https://spaces.nexudus.com/api/spaces/resourceaccessrules" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "BusinessId": 0,
    "Name": "",
    "AppliedResourcesCount": 0,
    "EvaluationOrder": 0,
    "CancellationFeeType": 0,
    "EligibleTimeSlots": [
        {
            "DayOfWeek": 0,
            "FromTime": "2025-01-15T10:30:00Z",
            "ToTime": "2025-01-15T10:30:00Z"
        }
    ],
    "TimeSlots": [
        {
            "DayOfWeek": 0,
            "FromTime": "2025-01-15T10:30:00Z",
            "ToTime": "2025-01-15T10:30:00Z"
        }
    ]
}'

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

Errors

array

null on success.

Example Response

{
  "Status": 200,
  "Message": "ResourceAccessRule 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.

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
}

Update ResourceAccessRuleUpdate an existing ResourceAccessRule record.

Create ResourceAccessRule

curl --request POST \
  --url https://spaces.nexudus.com/api/spaces/resourceaccessrules \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "BusinessId": 123,
  "Name": "<string>",
  "AppliedResourcesCount": 123,
  "EvaluationOrder": 123,
  "CancellationFeeType": 123
}
'

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

Documentation Index

​Scope: who the rule applies to

​Scope: who is allowed to book when the rule fires

​List mutation helpers

​Authentication

​Enums

​Request Body

​Required Fields

​Optional Fields

​Children

​Code Examples

​Response

​200

​400

Scope: who the rule applies to

Scope: who is allowed to book when the rule fires

List mutation helpers

Authentication

Enums

Request Body

Required Fields

Optional Fields

Children

Code Examples

Response

200

400