Create HelpDeskMessage

POST

api

support

helpdeskmessages

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

import requests

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

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

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    BusinessId: 123,
    CoworkerId: 123,
    Subject: '<string>',
    MessageText: '<string>',
    Priority: 123,
    AiProcessingResult: 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>"
    }
  ]
}

A HelpDeskMessage represents a support ticket submitted by a customer or created by staff. Each message has a priority level, can be assigned to a department, and tracks its resolution status.

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-Create 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

ID of the business linked to this record.

integer

required

ID of the coworker linked to this record.

string

required

The subject value for this help desk message.

string

required

The message text value for this help desk message.

integer

required

The priority value for this help desk message.

integer

required

The ai processing result value for this help desk message.

Optional Fields

integer

ID of the help desk department linked to this record.

boolean

Whether closed is enabled.

integer

ID of the owner linked to this record.

string

URL of a new file to upload as the image.

boolean

Set to true to remove the current image file.

Code Examples

curl -X POST \
  "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
}'

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

const data = await response.json();

import requests

response = requests.post(
    '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,
        'AiProcessingResult': 0
    }
)

data = response.json()

Response

200

integer

HTTP status code. 200 on success.

string

A human-readable message confirming the creation.

object

Contains the Id of the newly created record.

boolean

true if the helpdeskmessage was created successfully.

array

null on success.

Example Response

{
  "Status": 200,
  "Message": "HelpDeskMessage was successfully created.",
  "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 HelpDeskMessageUpdate an existing HelpDeskMessage record.

Create HelpDeskMessage

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

import requests

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

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

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    BusinessId: 123,
    CoworkerId: 123,
    Subject: '<string>',
    MessageText: '<string>',
    Priority: 123,
    AiProcessingResult: 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