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

Required full name shown for this staff account..

string

required

Required valid email address used to identify and sign in to this staff account..

integer

required

Legacy language setting; use PreferredLanguage instead..

string

required

Password-hashing salt generated by the platform; never expose or set it..

integer

required

Internal identifier of the last help page viewed by this user..

Internal count of failed login attempts; the platform resets it after a successful password change and applies its lockout threshold..

Optional Fields

string

Authentication token generated by the platform; never expose or set it..

integer

ID of the optional location language used for this account’s preferred interface and content language..

string

New sign-in password; do not expose or set passwords through the Admin Agent..

string

Stored password hash; never expose or set it directly..

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 optional marketplace application whose integration uses this account..

boolean

Whether this staff account is active; notification recipient queries generally require an active account..

boolean

Whether this account has administrator access in addition to any permissions granted through UserRoles..

boolean

Whether this account may authenticate for API access..

boolean

Whether the platform marks this account as validated..

boolean

Whether the user must reset their sign-in password; the platform sets this when it generates a password..

string

Read-only UTC timestamp of the latest account access, rounded down to the nearest 15 minutes..

string

Registered device identifiers used for device-based authentication; manage them outside the Admin Agent..

boolean

Whether to notify this active user about new internal messages for their locations..

boolean

Whether to notify this active user about new help desk messages for their locations..

boolean

Whether to notify this active user about new community wall posts for their locations..

boolean

Whether to notify this active user when a new customer profile is created for their locations..

boolean

Whether to notify this user about customer profile changes..

boolean

Whether to notify this active user with a customer profile at the location about new blog comments..

boolean

Whether to notify this active user with a customer profile at the location about new calendar-event comments..

boolean

Whether to notify this active user about plan changes; virtual-office plans instead use OnVirtualOfficeTariffChange..

boolean

Whether to notify this active user about booking changes for their locations..

boolean

Whether to notify this active user about tentative booking changes for their locations..

boolean

Whether to notify this active user about purchases for their locations..

boolean

Whether to notify this user when visitors register at their locations..

boolean

Whether to notify this user about Nexudus platform invoices for their locations..

boolean

Whether this user is subscribed to scheduled community-board digest emails; new accounts inherit the location digest setting..

boolean

Whether this user receives an email for each new community-board message instead of only digest notifications..

string

Two-factor authentication secret; never expose or set it..

string

Internal token-invalidating password-hash claim; never expose or set it..

integer[]

List of locations this staff account can access; the account is included in location-scoped user queries only when linked to that location..

integer[]

List of location-scoped user roles that grant this account permissions; administrator access may grant permissions independently..

integer[]

Internal list of support chat rooms linked to this user; manage chat membership outside the Admin Agent..

string

Internal timestamp of the latest community thread included in this user’s notification tracking..

string

Internal timestamp of the latest community message included in this user’s notification tracking..

string

Internal timestamp for this user’s next scheduled community digest..

string

Internal support-team routing email associated with this account..

Internal timestamp of the most recent failed login attempt, used with InvalidLoginAttempts for lockout handling..

boolean

Whether to notify this user about access-control errors for their locations..

string

Timestamp of the next help desk message reminder for this user..

boolean

Whether to notify this user when a customer is removed from a team..

boolean

Whether to notify this active user about virtual-office plan changes for their locations..

boolean

Whether to notify this user when a virtual-office customer updates delivery preferences..

boolean

Whether to notify this user when a customer’s identity-check status changes..

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
}

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