Skip to main content
POST
/
api
/
spaces
/
bookingnotes
{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}
A BookingNote is a text note attached to a Booking. These notes are visible to customers and are included in booking confirmation messages. To add notes that customers cannot see, use the InternalNotes field on the Booking entity instead.

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

Request Body

Required Fields

BookingId
integer
required
Booking Id.
Notes
string
required
The text content of the note, visible to customers in booking confirmations.

Code Examples

curl -X POST \
  "https://spaces.nexudus.com/api/spaces/bookingnotes" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "BookingId": 0,
    "Notes": ""
}'

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 bookingnote was created successfully.
Errors
array
null on success.
Example Response
{
  "Status": 200,
  "Message": "BookingNote 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.
WasSuccessful
boolean
false when the request fails validation.
Example Response
{
  "Message": "Notes: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Notes"
    }
  ],
  "WasSuccessful": false
}