Update HelpDeskMessage

PUT

api

support

helpdeskmessages

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
}
'

import requests

url = "https://spaces.nexudus.com/api/support/helpdeskmessages"

payload = {
    "Id": 123,
    "BusinessId": 123,
    "CoworkerId": 123,
    "Subject": "<string>",
    "MessageText": "<string>",
    "Priority": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    Id: 123,
    BusinessId: 123,
    CoworkerId: 123,
    Subject: '<string>',
    MessageText: '<string>',
    Priority: 123
  })
};

fetch('https://spaces.nexudus.com/api/support/helpdeskmessages', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "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

eSupportIssueCategory

Value	Name
1	Printing
2	WiFi
3	Access
4	Billing
5	Noise
6	HVAC
7	Cleaning
8	Booking
9	Other

Request Body

Required Fields

integer

required

The Id of the HelpDeskMessage record to update.

integer

required

ID of the location that owns this support ticket; it is supplied from the agent context..

integer

required

ID of the customer who opened this support ticket..

string

required

Required ticket subject, up to 254 characters..

string

required

Required initial message describing the customer’s support request; multiline text is allowed..

integer

required

Ticket urgency: Low, Normal, High, or Critical; new tickets default to Normal when no priority is supplied..

Optional Fields

integer

Optional ID of the support department that receives the ticket and can trigger its task-list workflow..

boolean

Whether the ticket is closed; closing records the closure time and reopening clears it..

integer

Optional ID of the staff user currently assigned to own the ticket..

string

URL of a new file to upload as the image.

boolean

Set to true to remove the current image file.

integer

System-managed ID of the AI channel session that escalated this ticket; do not set it through help desk ticket operations..

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

const response = await fetch(
  'https://spaces.nexudus.com/api/support/helpdeskmessages',
  {
    method: 'PUT',
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      BusinessId: 0,
      CoworkerId: 0,
      Subject: '',
      MessageText: '',
      Priority: 0,
      Id: 87654321
    })
  }
);

const data = await response.json();

import requests

response = requests.put(
    'https://spaces.nexudus.com/api/support/helpdeskmessages',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'BusinessId': 0,
        'CoworkerId': 0,
        'Subject': '',
        'MessageText': '',
        'Priority': 0,
        'Id': 87654321
    }
)

data = response.json()

Response

200

integer

HTTP status code. 200 on success.

string

A human-readable message confirming the update.

object

Contains the Id of the updated record.

boolean

true if the helpdeskmessage was updated successfully.

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

string

A summary of the validation error(s), in the format PropertyName: error message.

any

null on validation failure.

object[]

Array of validation errors.

Show child attributes

any

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

string

The validation error message.

string

The name of the property that failed validation.

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
}

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
}
'

import requests

url = "https://spaces.nexudus.com/api/support/helpdeskmessages"

payload = {
    "Id": 123,
    "BusinessId": 123,
    "CoworkerId": 123,
    "Subject": "<string>",
    "MessageText": "<string>",
    "Priority": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    Id: 123,
    BusinessId: 123,
    CoworkerId: 123,
    Subject: '<string>',
    MessageText: '<string>',
    Priority: 123
  })
};

fetch('https://spaces.nexudus.com/api/support/helpdeskmessages', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

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

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

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

Authentication

Enums

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400