Skip to main content
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
}
'
{
  "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

ValueName
3EnglishUK
1EnglishUS
2Spanish

Request Body

Required Fields

FullName
string
required
The full name value for this user.
Email
string
required
The email value for this user.
Language
integer
required
The language value for this user.
PasswordSalt
string
required
The password salt value for this user.
LastHelpVisited
integer
required
The last help visited value for this user.
InvalidLoginAttempts
integer
required
The invalid login attempts value for this user.

Optional Fields

AccessToken
string
The access token value for this user.
PreferredLanguageId
integer
ID of the preferred language linked to this record.
NewPassword
string
The new password value for this user.
Password
string
The password value for this user.
NewAvatarUrl
string
URL of a new file to upload as the avatar.
ClearAvatarFile
boolean
Set to true to remove the current avatar file.
ApplicationId
integer
ID of the application linked to this record.
Active
boolean
Whether this user is currently active.
IsAdmin
boolean
Whether is admin is enabled.
APIAccess
boolean
Whether api access is enabled.
Validated
boolean
Whether validated is enabled.
MustResetPassword
boolean
Whether must reset password is enabled.
LastAccess
string
Date/time value for last access.
Devices
string
The devices value for this user.
OnNewEmail
boolean
Whether on new email is enabled.
OnHelpDeskMsg
boolean
Whether on help desk msg is enabled.
OnNewWallPost
boolean
Whether on new wall post is enabled.
OnNewMember
boolean
Whether on new member is enabled.
OnProfileChanges
boolean
Whether on profile changes is enabled.
OnNewBlogComment
boolean
Whether on new blog comment is enabled.
OnNewEventComment
boolean
Whether on new event comment is enabled.
OnTariffChange
boolean
Whether on tariff change is enabled.
OnBookingChange
boolean
Whether on booking change is enabled.
OnTentativeBookingChange
boolean
Whether on tentative booking change is enabled.
OnPurchases
boolean
Whether on purchases is enabled.
OnVisitorRegistration
boolean
Whether on visitor registration is enabled.
OnPlaformInvoices
boolean
Whether on plaform invoices is enabled.
ReceiveCommunityDigest
boolean
Whether receive community digest is enabled.
ReceiveEveryMessage
boolean
Whether receive every message is enabled.
TwoFactorSecret
string
The two factor secret value for this user.
EmailCallBackGuid
string
Unique identifier (GUID) for the email call back.
Businesses
integer[]
List of businesses linked to this record.
UserRoles
integer[]
List of user roles linked to this record.
ChatRooms
integer[]
List of chat rooms linked to this record.
LastReceivedCommunityThreadDate
string
Date/time value for last received community thread date.
LastReceivedCommunityMessageDate
string
Date/time value for last received community message date.
NextCommunityDigest
string
Date/time value for next community digest.
SupportTeamUserEmail
string
The support team user email value for this user.
LastLoginAttempt
string
Date/time value for last login attempt.
OnAccessControlErrors
boolean
Whether on access control errors is enabled.
NextHelpDeskMessageReminder
string
Date/time value for next help desk message reminder.
OnMemberRemovedFromTeam
boolean
Whether on member removed from team is enabled.
OnVirtualOfficeTariffChange
boolean
Whether on virtual office tariff change is enabled.
OnVirtualOfficeDeliveryPreferenceUpdate
boolean
Whether on virtual office delivery preference update is enabled.
OnIdentityCheckUpdate
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
}'

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

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