Create User

POST

api

sys

users

Create User

curl --request POST \
  --url https://spaces.nexudus.com/api/sys/users \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "FullName": "<string>",
  "Email": "<string>",
  "Language": 123,
  "PasswordSalt": "<string>",
  "LastHelpVisited": 123,
  "InvalidLoginAttempts": 123
}
'

import requests

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

payload = {
    "FullName": "<string>",
    "Email": "<string>",
    "Language": 123,
    "PasswordSalt": "<string>",
    "LastHelpVisited": 123,
    "InvalidLoginAttempts": 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({
    FullName: '<string>',
    Email: '<string>',
    Language: 123,
    PasswordSalt: '<string>',
    LastHelpVisited: 123,
    InvalidLoginAttempts: 123
  })
};

fetch('https://spaces.nexudus.com/api/sys/users', 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 User represents an administrator or staff member who can sign in to the Nexudus admin panel. Users are assigned roles that control their permissions and can be associated with one or more business locations.

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

Enums

eLanguage — Language values

Value	Name
3	EnglishUK
1	EnglishUS
2	Spanish

Request Body

Required Fields

string

required

The full name value for this user.

string

required

The email value for this user.

integer

required

The language value for this user.

string

required

The password salt value for this user.

integer

required

The last help visited value for this user.

The invalid login attempts value for this user.

Optional Fields

string

The access token value for this user.

integer

ID of the preferred language linked to this record.

string

The new password value for this user.

string

The password value for this user.

string

URL of a new file to upload as the avatar.

boolean

Set to true to remove the current avatar file.

integer

ID of the application linked to this record.

boolean

Whether this user is currently active.

boolean

Whether is admin is enabled.

boolean

Whether api access is enabled.

boolean

Whether validated is enabled.

boolean

Whether must reset password is enabled.

string

Date/time value for last access.

string

The devices value for this user.

boolean

Whether on new email is enabled.

boolean

Whether on help desk msg is enabled.

boolean

Whether on new wall post is enabled.

boolean

Whether on new member is enabled.

boolean

Whether on profile changes is enabled.

boolean

Whether on new blog comment is enabled.

boolean

Whether on new event comment is enabled.

boolean

Whether on tariff change is enabled.

boolean

Whether on booking change is enabled.

boolean

Whether on tentative booking change is enabled.

boolean

Whether on purchases is enabled.

boolean

Whether on visitor registration is enabled.

boolean

Whether on plaform invoices is enabled.

boolean

Whether receive community digest is enabled.

boolean

Whether receive every message is enabled.

string

The two factor secret value for this user.

string

Unique identifier (GUID) for the email call back.

integer[]

List of businesses linked to this record.

integer[]

List of user roles linked to this record.

integer[]

List of chat rooms linked to this record.

string

Date/time value for last received community thread date.

string

Date/time value for last received community message date.

string

Date/time value for next community digest.

string

The support team user email value for this user.

Date/time value for last login attempt.

boolean

Whether on access control errors is enabled.

string

Date/time value for next help desk message reminder.

boolean

Whether on member removed from team is enabled.

boolean

Whether on virtual office tariff change is enabled.

boolean

Whether on virtual office delivery preference update is enabled.

boolean

Whether on identity check update is enabled.

Code Examples

curl -X POST \
  "https://spaces.nexudus.com/api/sys/users" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "FullName": "",
    "Email": "",
    "Language": 0,
    "PasswordSalt": "",
    "LastHelpVisited": 0,
    "InvalidLoginAttempts": 0
}'

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/users',
  {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      FullName: '',
      Email: '',
      Language: 0,
      PasswordSalt: '',
      LastHelpVisited: 0,
      InvalidLoginAttempts: 0
    })
  }
);

const data = await response.json();

import requests

response = requests.post(
    'https://spaces.nexudus.com/api/sys/users',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'FullName': '',
        'Email': '',
        'Language': 0,
        'PasswordSalt': '',
        'LastHelpVisited': 0,
        'InvalidLoginAttempts': 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 user was created successfully.

array

null on success.

Example Response

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

Update UserUpdate an existing User record.

Create User

curl --request POST \
  --url https://spaces.nexudus.com/api/sys/users \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "FullName": "<string>",
  "Email": "<string>",
  "Language": 123,
  "PasswordSalt": "<string>",
  "LastHelpVisited": 123,
  "InvalidLoginAttempts": 123
}
'

import requests

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

payload = {
    "FullName": "<string>",
    "Email": "<string>",
    "Language": 123,
    "PasswordSalt": "<string>",
    "LastHelpVisited": 123,
    "InvalidLoginAttempts": 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({
    FullName: '<string>',
    Email: '<string>',
    Language: 123,
    PasswordSalt: '<string>',
    LastHelpVisited: 123,
    InvalidLoginAttempts: 123
  })
};

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

Enums

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400

​Authentication

​Enums

​Request Body

​Required Fields

​Optional Fields

​Code Examples

​Response

​200

​400

Authentication

Enums

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400