Create BookingVisitor

POST

api

spaces

bookingvisitors

curl --request POST \
  --url https://spaces.nexudus.com/api/spaces/bookingvisitors \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "BookingId": 123,
  "VisitorId": 123
}
'

import requests

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

payload = {
    "BookingId": 123,
    "VisitorId": 123
}
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({BookingId: 123, VisitorId: 123})
};

fetch('https://spaces.nexudus.com/api/spaces/bookingvisitors', 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 BookingVisitor links a Visitor to a Booking, representing a guest associated with that booking. Visitors can only be added to bookings that are associated with a customer (Booking.CoworkerId is not null). When a visitor is added to a booking, they may receive a booking confirmation email and a visitor invite email, depending on the notification settings configured for the location of the booked resource.

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

Request Body

Required Fields

integer

required

ID of the booking this visitor is attending. The booking determines this record’s location; the visitor email must be unique within the booking and must not match the booking customer’s email..

integer

required

ID of the visitor attending the selected booking. The visitor is a location-scoped record; creating or updating the link may update access-control keys for customers with the same email..

Code Examples

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

const response = await fetch(
  'https://spaces.nexudus.com/api/spaces/bookingvisitors',
  {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      BookingId: 0,
      VisitorId: 0
    })
  }
);

const data = await response.json();

import requests

response = requests.post(
    'https://spaces.nexudus.com/api/spaces/bookingvisitors',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'BookingId': 0,
        'VisitorId': 0
    }
)

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

array

null on success.

Example Response

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

Create BookingVisitor

curl --request POST \
  --url https://spaces.nexudus.com/api/spaces/bookingvisitors \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "BookingId": 123,
  "VisitorId": 123
}
'

import requests

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

payload = {
    "BookingId": 123,
    "VisitorId": 123
}
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({BookingId: 123, VisitorId: 123})
};

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

Request Body

Required Fields

Code Examples

Response

200

400

​Authentication

​Request Body

​Required Fields

​Code Examples

​Response

​200

​400

Authentication

Request Body

Required Fields

Code Examples

Response

200

400