Skip to main content
POST
/
api
/
spaces
/
bookingnotes
/
runcommand
{
  "Status": 123,
  "Message": "<string>",
  "Value": {},
  "WasSuccessful": true,
  "Errors": [
    {}
  ]
}
Executes a command on one or more BookingNote records. Use the Commands endpoint to discover available commands and their required parameters.

​
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-Update role.

​
Request Body

​
Key
string
required
The command key to execute. Obtain available keys from the Commands endpoint.
​
Ids
integer[]
required
List of BookingNote record Ids to execute the command on.
​
Parameters
object[]
If the command requires parameters, provide them as an array of objects with Name and Value fields.

​
Code Examples

curl -X POST \
  "https://spaces.nexudus.com/api/spaces/bookingnotes/runcommand" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "Key": "COMMAND_KEY_1",
    "Ids": [87654321, 87654322],
    "Parameters": [
      {
        "Name": "Parameter name",
        "Value": "Parameter value"
      }
    ]
  }'

​
Response

​
200

​
Status
integer
HTTP status code. 200 on success.
​
Message
string
A human-readable message confirming the command was executed.
​
Value
object
Contains details about the command execution result.
​
WasSuccessful
boolean
true if the command was executed successfully.
​
Errors
array
null on success.
Example Response
{
  "Status": 200,
  "Message": "The command was run correctly.",
  "Value": null,
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}