Create VideoRoom

POST

api

community

videorooms

Create VideoRoom

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

import requests

url = "https://spaces.nexudus.com/api/community/videorooms"

payload = {
    "BusinessId": 123,
    "Name": "<string>",
    "NumberOfParticipants": 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({BusinessId: 123, Name: '<string>', NumberOfParticipants: 123})
};

fetch('https://spaces.nexudus.com/api/community/videorooms', 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 VideoRoom represents a virtual meeting room for video conferencing. Video rooms enable online meetings between members and can be integrated with booking resources.

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

Request Body

Required Fields

integer

required

ID of the business linked to this record.

string

required

The name value for this video room.

integer

required

The number of participants value for this video room.

Optional Fields

string

Free-text description of this video room.

string

URL of a new file to upload as the image.

boolean

Set to true to remove the current image file.

boolean

Whether this video room is currently active.

boolean

Whether only for contacts is enabled.

boolean

Whether only for members is enabled.

Code Examples

curl -X POST \
  "https://spaces.nexudus.com/api/community/videorooms" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "BusinessId": 0,
    "Name": "",
    "NumberOfParticipants": 0
}'

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

const data = await response.json();

import requests

response = requests.post(
    'https://spaces.nexudus.com/api/community/videorooms',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'BusinessId': 0,
        'Name': '',
        'NumberOfParticipants': 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 videoroom was created successfully.

array

null on success.

Example Response

{
  "Status": 200,
  "Message": "VideoRoom 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
}

Update VideoRoomUpdate an existing VideoRoom record.

Create VideoRoom

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

import requests

url = "https://spaces.nexudus.com/api/community/videorooms"

payload = {
    "BusinessId": 123,
    "Name": "<string>",
    "NumberOfParticipants": 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({BusinessId: 123, Name: '<string>', NumberOfParticipants: 123})
};

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

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