Skip to main content
PUT
/
api
/
sys
/
openaichatmessages
Update OpenAiChatMessage
curl --request PUT \
  --url https://spaces.nexudus.com/api/sys/openaichatmessages \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "Id": 123,
  "BusinessId": 123,
  "Action": 123,
  "Content": "<string>"
}
'
{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}
Updates an existing OpenAiChatMessage 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 OpenAiChatMessage-Edit role.

Enums

ValueName
1Operator

Request Body

Required Fields

Id
integer
required
The Id of the OpenAiChatMessage record to update.
BusinessId
integer
required
ID of the business linked to this record.
Action
integer
required
The action value for this open ai chat message.
Content
string
required
The content value for this open ai chat message.

Optional Fields

UserId
integer
ID of the user linked to this record.
AiChannelSessionId
integer
ID of the AI channel session linked to this message. Sessions group all messages in a conversation and link it to a specific user and AI channel (e.g. email, chat, WhatsApp).

Code Examples

curl -X PUT \
  "https://spaces.nexudus.com/api/sys/openaichatmessages" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "BusinessId": 0,
    "Action": 0,
    "Content": "",
    "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 openaichatmessage was updated successfully.
Errors
array
null on success.
Example Response
{
  "Status": 200,
  "Message": "OpenAiChatMessage 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": "Action: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Action"
    }
  ],
  "WasSuccessful": false
}