Skip to main content
POST
/
api
/
sys
/
users
{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

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.

Request Body

Required Fields

FullName
string
required
Full Name.
Email
string
required
Email.
PasswordSalt
string
required
Password Salt.
LastHelpVisited
integer
required
Last Help Visited.
InvalidLoginAttempts
integer
required
Invalid Login Attempts.

Optional Fields

AccessToken
string
Access Token.
Language
integer
Language. See eLanguage enum above.
PreferredLanguageId
integer
Preferred Language Id.
NewPassword
string
New Password.
Password
string
Password.
NewAvatarUrl
string
New Avatar Url.
ClearAvatarFile
boolean
Clear Avatar File.
ApplicationId
integer
Application Id.
Active
boolean
Active.
IsAdmin
boolean
Is Admin.
APIAccess
boolean
APIAccess.
Validated
boolean
Validated.
MustResetPassword
boolean
Must Reset Password.
LastAccess
string
Last Access.
Devices
string
Devices.
OnNewEmail
boolean
On New Email.
OnHelpDeskMsg
boolean
On Help Desk Msg.
OnNewWallPost
boolean
On New Wall Post.
OnNewMember
boolean
On New Member.
OnProfileChanges
boolean
On Profile Changes.
OnNewBlogComment
boolean
On New Blog Comment.
OnNewEventComment
boolean
On New Event Comment.
OnTariffChange
boolean
On Tariff Change.
OnBookingChange
boolean
On Booking Change.
OnTentativeBookingChange
boolean
On Tentative Booking Change.
OnPurchases
boolean
On Purchases.
OnVisitorRegistration
boolean
On Visitor Registration.
OnPlaformInvoices
boolean
On Plaform Invoices.
ReceiveCommunityDigest
boolean
Receive Community Digest.
ReceiveEveryMessage
boolean
Receive Every Message.
TwoFactorSecret
string
Two Factor Secret.
EmailCallBackGuid
string
Email Call Back Guid.
Businesses
integer[]
Businesses.
UserRoles
integer[]
User Roles.
ChatRooms
integer[]
Chat Rooms.
LastReceivedCommunityThreadDate
string
Last Received Community Thread Date.
LastReceivedCommunityMessageDate
string
Last Received Community Message Date.
NextCommunityDigest
string
Next Community Digest.
SupportTeamUserEmail
string
Support Team User Email.
LastLoginAttempt
string
Last Login Attempt.
OnAccessControlErrors
boolean
On Access Control Errors.
NextHelpDeskMessageReminder
string
Next Help Desk Message Reminder.
OnMemberRemovedFromTeam
boolean
On Member Removed From Team.
OnVirtualOfficeTariffChange
boolean
On Virtual Office Tariff Change.
OnVirtualOfficeDeliveryPreferenceUpdate
boolean
On Virtual Office Delivery Preference Update.
OnIdentityCheckUpdate
boolean
On Identity Check Update.

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": "",
    "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
}