Create UiModule

POST

api

sys

uimodules

Create UiModule

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

import requests

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

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

fetch('https://spaces.nexudus.com/api/sys/uimodules', 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 UiModule represents a configurable user interface component or widget that can be enabled or disabled for a location’s admin dashboard or member portal.

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

Request Body

Required Fields

integer

required

ID of the business linked to this record.

string

required

The name value for this ui module.

string

required

The access url value for this ui module.

string

required

The icon value for this ui module.

Optional Fields

boolean

Whether this ui module is currently active.

string

The shared secret value for this ui module.

Code Examples

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

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

const data = await response.json();

import requests

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

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

array

null on success.

Example Response

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

Create UiModule

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

import requests

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

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

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