Create BusinessDomain

POST

api

sys

businessdomains

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

import requests

url = "https://spaces.nexudus.com/api/sys/businessdomains"

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

fetch('https://spaces.nexudus.com/api/sys/businessdomains', 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 BusinessDomain represents a custom domain or subdomain configured for a location’s Members Portal. By default each location gets a <name>.spaces.nexudus.com address. A BusinessDomain lets you replace that with your own domain (e.g. coworking.com) or subdomain (e.g. london.coworking.com).

For custom domains, an SSL proxy (e.g. CloudFlare) must be configured and SslProxy must be set to true.
For custom subdomains, a CNAME record pointing to Nexudus is required. SslProxy must still be set to true.

Use ActiveFrom and ActiveTo to schedule when the domain mapping takes effect. Changes typically propagate within two to three days.

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

Request Body

Required Fields

integer

required

ID of the business linked to this record.

string

required

Display name for this domain mapping.

string

required

The custom domain or subdomain hostname — despite the name, this is just the bare domain (e.g. coworking.com or london.coworking.com), without https:// or any path.

Optional Fields

boolean

Whether this domain mapping is active.

boolean

Must always be set to true.

string

Date from which this domain mapping becomes active.

string

Date after which this domain mapping is no longer active.

Code Examples

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

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

const data = await response.json();

import requests

response = requests.post(
    'https://spaces.nexudus.com/api/sys/businessdomains',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'BusinessId': 0,
        'Name': '',
        'DomainURL': ''
    }
)

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

array

null on success.

Example Response

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

Create BusinessDomain

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

import requests

url = "https://spaces.nexudus.com/api/sys/businessdomains"

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

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