Create CancelledBooking

POST

api

spaces

cancelledbookings

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

import requests

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

payload = {
    "ResourceId": 123,
    "FromTime": "<string>",
    "ToTime": "<string>",
    "Repeats": 123,
    "WhichBookingsToUpdate": 123,
    "CancelledOn": "<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({
    ResourceId: 123,
    FromTime: '<string>',
    ToTime: '<string>',
    Repeats: 123,
    WhichBookingsToUpdate: 123,
    CancelledOn: '<string>'
  })
};

fetch('https://spaces.nexudus.com/api/spaces/cancelledbookings', 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 CancelledBooking is a read-only snapshot of a booking that was removed from the calendar. When a booking is cancelled, the system preserves its details — resource, coworker, time range, price, and cancellation metadata — so they remain available for reporting and auditing. Cancelled bookings cannot be created or modified through the API; they are generated automatically when an active Booking is cancelled. Use list and get to query cancellation history. The CancellationReason field indicates why the booking was removed. Possible reasons include the customer no longer needing the booking, cost concerns, rebooking for a different time, failure to pay upfront, automated cancellation due to not checking in, and others.

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

Enums

eBookingCancellationReason

Value	Name
0	Unknown
1	NoLongerNeeded
2	TooExpensive
3	BadPreviousExperience
4	RebookedForADifferentTime
5	FailedToPayUpfront
6	Integration
7	Other
8	NotCheckedIn
9	MarketPlace

eBookingRepeatCycle — Repeats values

Value	Name
1	Daily
2	Weekly
3	Monthly
4	Yearly
5	FirstOfMonth
6	SecondOfMonth
7	ThirdOfMonth
8	LastOfMonth
9	FourthOfMonth

eRepeatedBookingUpdateAction — WhichBookingsToUpdate values

Value	Name
1	UpdateThisBookingOnly
2	UpdateFutureBookingsOnly
3	UpdateAllBookings
4	UpdateNotChargedBookings
5	DeleteAllBookings
6	DeleteBookingsAfterThis
7	DeleteNotChargedBookings
8	RevertAllCharges

Request Body

Required Fields

integer

required

ID of the resource linked to this record.

string

required

Booking start time.

string

required

Booking end time.

integer

required

The repeats value for this cancelled booking.

integer

required

Date/time value for which bookings to update.

string

required

Date and time when the booking was cancelled.

Optional Fields

integer

ID of the floor plan desk linked to this record.

integer

ID of the coworker linked to this record.

integer

ID of the extra service linked to this record.

string

Optional notes or comments about this cancelled booking.

string

The internal notes value for this cancelled booking.

boolean

Whether charge now is enabled.

boolean

Whether invoice now is enabled.

boolean

Whether invoice this coworker is enabled.

boolean

Whether do not use booking credit is enabled.

string

The purchase order value for this cancelled booking.

string

The discount code value for this cancelled booking.

string

Date/time value for last notification time.

string

ID of the google calendar associated with this record.

string

ID of the google event associated with this record.

string

ID of the office365 event associated with this record.

string

ID of the public google event associated with this record.

boolean

Tentative booking. Must be approved by an administrator before confirmed or charged. Tentative bookings still block the calendar.

boolean

Whether online is enabled.

string

The teams at the time of booking value for this cancelled booking.

string

The tariff at the time of booking value for this cancelled booking.

string

ID of the repeat series unique associated with this record.

boolean

Whether repeat booking is enabled.

integer

The repeat every value for this cancelled booking.

string

Date/time value for repeat until.

boolean

Whether repeat on mondays is enabled.

boolean

Whether repeat on tuesdays is enabled.

boolean

Whether repeat on wednesdays is enabled.

boolean

Whether repeat on thursdays is enabled.

boolean

Whether repeat on fridays is enabled.

boolean

Whether repeat on saturdays is enabled.

boolean

Whether repeat on sundays is enabled.

boolean

Whether reminded is enabled.

boolean

Whether mrm reminded is enabled.

number

The override price value for this cancelled booking.

boolean

Whether the booking had been charged. When true, a charge (CoworkerExtraService) had been posted to the customer account.

string

Date/time value for invoice date.

integer

The booking number value for this cancelled booking.

integer

ID of the kisi key associated with this record.

string

ID of the start scheduled job associated with this record.

string

ID of the end scheduled job associated with this record.

boolean

Whether billed is enabled.

string

Date/time value for from time local.

string

Date/time value for to time local.

string

Date/time value for invoice date local.

integer

ID of the coworker invoice associated with this record.

string

The coworker invoice number value for this cancelled booking.

boolean

Whether coworker invoice paid is enabled.

boolean

Whether coworker invoice draft is enabled.

boolean

Whether coworker invoice void is enabled.

boolean

Whether coworker invoice credit note is enabled.

string

The coworker extra service ids value for this cancelled booking.

number

The coworker extra service price value for this cancelled booking.

string

The coworker extra service currency code value for this cancelled booking.

integer

The coworker extra service charge period value for this cancelled booking.

integer

The coworker extra service total uses value for this cancelled booking.

boolean

Whether include zoom invite is enabled.

string

The zoom event data value for this cancelled booking.

string

Date/time value for checked in at.

boolean

Whether cancel if not paid is enabled.

boolean

Whether cancel if not checked in is enabled.

integer

The max occupancy value for this cancelled booking.

number

The last minute price adjustment value for this cancelled booking.

number

The dynamic price adjustment value for this cancelled booking.

number

The price factor last minute value for this cancelled booking.

number

The price factor demand value for this cancelled booking.

string

ID of the office365 admin event associated with this record.

integer

Reason the booking was cancelled, e.g. NoLongerNeeded, TooExpensive, or NotCheckedIn. See eBookingCancellationReason? enum above.

string

Name or identifier of the user who cancelled the booking.

string

Additional free-text details explaining the cancellation reason.

number

Booking price.

string

ID of the original booking associated with this record.

Code Examples

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

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

const data = await response.json();

import requests

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

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

array

null on success.

Example Response

{
  "Status": 200,
  "Message": "CancelledBooking 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 CancelledBookingUpdate an existing CancelledBooking record.

Create CancelledBooking

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

import requests

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

payload = {
    "ResourceId": 123,
    "FromTime": "<string>",
    "ToTime": "<string>",
    "Repeats": 123,
    "WhichBookingsToUpdate": 123,
    "CancelledOn": "<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({
    ResourceId: 123,
    FromTime: '<string>',
    ToTime: '<string>',
    Repeats: 123,
    WhichBookingsToUpdate: 123,
    CancelledOn: '<string>'
  })
};

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