Update User - Nexudus Platform

PUT

api

sys

users

Update User

curl --request PUT \
  --url https://spaces.nexudus.com/api/sys/users \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "Id": 123,
  "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>"
    }
  ]
}

Updates an existing User record. You must include the Id of the record to update along with all required fields.

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-Edit role.

Enums

eLanguage — Language values

Value	Name
3	EnglishUK
1	EnglishUS
2	Spanish

Request Body

Required Fields

integer

required

The Id of the User record to update.

FullName

string

required

The full name value for this user.

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.

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.

AddedBusinesses

integer[]

The added businesses value for this user.

RemovedBusinesses

integer[]

The removed businesses value for this user.

UserRoles

integer[]

List of user roles linked to this record.

AddedUserRoles

integer[]

The added user roles value for this user.

RemovedUserRoles

integer[]

The removed user roles value for this user.

ChatRooms

integer[]

List of chat rooms linked to this record.

AddedChatRooms

integer[]

The added chat rooms value for this user.

RemovedChatRooms

integer[]

The removed chat rooms value for this user.

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.

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 PUT \
  "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,
    "Id": 87654321
}'

Response

200

Status

integer

HTTP status code. 200 on success.

Message

string

A human-readable message confirming the update.

Value

object

Contains the Id of the updated record.

WasSuccessful

boolean

true if the user was updated successfully.

Errors

array

null on success.

Example Response

{
  "Status": 200,
  "Message": "User was successfully updated.",
  "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.

Show child attributes

AttemptedValue

any

The value that was submitted for the field, or null if missing.

Message

string

The validation error message.

PropertyName

string

The name of the property that failed validation.

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
}

Delete UserDelete an existing User record by its Id.

Update User

curl --request PUT \
  --url https://spaces.nexudus.com/api/sys/users \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "Id": 123,
  "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>"
    }
  ]
}

​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