Create BookingAvailabilityException

POST

api

spaces

bookingavailabilityexceptions

curl --request POST \
  --url https://spaces.nexudus.com/api/spaces/bookingavailabilityexceptions \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "BusinessId": 123,
  "FromTime": "<string>",
  "ToTime": "<string>",
  "Message": "<string>"
}
'

import requests

url = "https://spaces.nexudus.com/api/spaces/bookingavailabilityexceptions"

payload = {
    "BusinessId": 123,
    "FromTime": "<string>",
    "ToTime": "<string>",
    "Message": "<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, FromTime: '<string>', ToTime: '<string>', Message: '<string>'})
};

fetch('https://spaces.nexudus.com/api/spaces/bookingavailabilityexceptions', 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 BookingAvailabilityException blocks one or more Resources from being booked during a specific date/time window. When a user tries to book a blocked resource, they see the configured Message instead of available time slots. Use exceptions for holidays, maintenance periods, or any other reason a resource should be temporarily unavailable. Set EveryYear to true for recurring annual closures (e.g. public holidays).

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

Request Body

Required Fields

integer

required

ID of the business linked to this record.

string

required

Start date/time of the blocked period.

string

required

End date/time of the blocked period.

string

required

Message shown to users who attempt to book a blocked resource.

Optional Fields

integer[]

List of resources linked to this record.

boolean

Whether this exception is currently enforced.

boolean

Whether this exception recurs annually on the same dates.

Code Examples

curl -X POST \
  "https://spaces.nexudus.com/api/spaces/bookingavailabilityexceptions" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "BusinessId": 0,
    "FromTime": "2025-01-15T10:30:00Z",
    "ToTime": "2025-01-15T10:30:00Z",
    "Message": ""
}'

const response = await fetch(
  'https://spaces.nexudus.com/api/spaces/bookingavailabilityexceptions',
  {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      BusinessId: 0,
      FromTime: '2025-01-15T10:30:00Z',
      ToTime: '2025-01-15T10:30:00Z',
      Message: ''
    })
  }
);

const data = await response.json();

import requests

response = requests.post(
    'https://spaces.nexudus.com/api/spaces/bookingavailabilityexceptions',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'BusinessId': 0,
        'FromTime': '2025-01-15T10:30:00Z',
        'ToTime': '2025-01-15T10:30:00Z',
        'Message': ''
    }
)

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

array

null on success.

Example Response

{
  "Status": 200,
  "Message": "BookingAvailabilityException 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": "FromTime: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "FromTime"
    }
  ],
  "WasSuccessful": false
}

Update BookingAvailabilityExceptionUpdate an existing BookingAvailabilityException record.

Create BookingAvailabilityException

curl --request POST \
  --url https://spaces.nexudus.com/api/spaces/bookingavailabilityexceptions \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "BusinessId": 123,
  "FromTime": "<string>",
  "ToTime": "<string>",
  "Message": "<string>"
}
'

import requests

url = "https://spaces.nexudus.com/api/spaces/bookingavailabilityexceptions"

payload = {
    "BusinessId": 123,
    "FromTime": "<string>",
    "ToTime": "<string>",
    "Message": "<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, FromTime: '<string>', ToTime: '<string>', Message: '<string>'})
};

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

Create BookingAvailabilityException

Authentication

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400

​Authentication

​Request Body

​Required Fields

​Optional Fields

​Code Examples

​Response

​200

​400

Authentication

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400