Skip to main content
POST
/
api
/
sys
/
businessdomains
{
  "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

​
BusinessId
integer
required
Business Id.
​
Name
string
required
Display name for this domain mapping.
​
DomainURL
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

​
Active
boolean
Whether this domain mapping is active.
​
SslProxy
boolean
Must always be set to true.
​
ActiveFrom
string
Date from which this domain mapping becomes active.
​
ActiveTo
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": ""
}'

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

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