Update HelpDeskMessage - Nexudus Platform

PUT

api

support

helpdeskmessages

Update HelpDeskMessage

curl --request PUT \
  --url https://spaces.nexudus.com/api/support/helpdeskmessages \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "Id": 123,
  "BusinessId": 123,
  "CoworkerId": 123,
  "Subject": "<string>",
  "MessageText": "<string>",
  "Priority": 123,
  "AiProcessingResult": 123
}
'

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

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

Enums

eHelpDeskMessagePriority — Priority values

Value	Name
1	Low
2	Normal
3	High
4	Critical

eHelpDeskAiResult — AiProcessingResult values

Value	Name
1	NotProcessed
2	Responded
3	NotResponded

Request Body

Required Fields

integer

required

The Id of the HelpDeskMessage record to update.

BusinessId

integer

required

ID of the business linked to this record.

CoworkerId

integer

required

ID of the coworker linked to this record.

Subject

string

required

The subject value for this help desk message.

MessageText

string

required

The message text value for this help desk message.

Priority

integer

required

The priority value for this help desk message.

AiProcessingResult

integer

required

The ai processing result value for this help desk message.

Optional Fields

HelpDeskDepartmentId

integer

ID of the help desk department linked to this record.

Closed

boolean

Whether closed is enabled.

OwnerId

integer

ID of the owner linked to this record.

NewImageUrl

string

URL of a new file to upload as the image.

ClearImageFile

boolean

Set to true to remove the current image file.

Code Examples

curl -X PUT \
  "https://spaces.nexudus.com/api/support/helpdeskmessages" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "BusinessId": 0,
    "CoworkerId": 0,
    "Subject": "",
    "MessageText": "",
    "Priority": 0,
    "AiProcessingResult": 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 helpdeskmessage was updated successfully.

Errors

array

null on success.

Example Response

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

Delete HelpDeskMessageDelete an existing HelpDeskMessage record by its Id.

Update HelpDeskMessage

curl --request PUT \
  --url https://spaces.nexudus.com/api/support/helpdeskmessages \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "Id": 123,
  "BusinessId": 123,
  "CoworkerId": 123,
  "Subject": "<string>",
  "MessageText": "<string>",
  "Priority": 123,
  "AiProcessingResult": 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