Skip to main content
PUT
/
api
/
sys
/
chatusermessages
Update ChatUserMessage
curl --request PUT \
  --url https://spaces.nexudus.com/api/sys/chatusermessages \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "Id": 123,
  "FromUserId": 123
}
'
{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://learn.nexudus.com/llms.txt

Use this file to discover all available pages before exploring further.

Updates an existing ChatUserMessage 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 ChatUserMessage-Edit role.

Request Body

Required Fields

Id
integer
required
The Id of the ChatUserMessage record to update.
FromUserId
integer
required
From User Id.

Optional Fields

ToUsers
integer[]
To Users.
AddedToUsers
integer[]
Added To Users.
RemovedToUsers
integer[]
Removed To Users.
ChatText
string
Chat Text.
Delievered
boolean
Delievered.

Code Examples

curl -X PUT \
  "https://spaces.nexudus.com/api/sys/chatusermessages" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "FromUserId": 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 chatusermessage was updated successfully.
Errors
array
null on success.
Example Response
{
  "Status": 200,
  "Message": "ChatUserMessage 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.
WasSuccessful
boolean
false when the request fails validation.
Example Response
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}