Create HelpDeskComment

POST

api

support

helpdeskcomments

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

import requests

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

payload = {
    "HelpDeskMessageId": 123,
    "CoworkerId": 123,
    "MessageText": "<string>"
}
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({HelpDeskMessageId: 123, CoworkerId: 123, MessageText: '<string>'})
};

fetch('https://spaces.nexudus.com/api/support/helpdeskcomments', 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 HelpDeskComment is a customer or staff reply, including internal notes, on a support ticket; creating one reopens the ticket and follows its notification rules.

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 HelpDeskComment-Create role.

Request Body

Required Fields

integer

required

ID of the support ticket this reply or note belongs to; it determines the owning location and a new comment reopens the ticket..

integer

required

ID of the customer or staff member who authored this comment; the author determines the notification path..

string

required

Required multiline text of the customer reply or staff note..

Optional Fields

boolean

Whether this is an internal staff note; when true it is not sent to the customer..

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/helpdeskcomments" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "HelpDeskMessageId": 0,
    "CoworkerId": 0,
    "MessageText": ""
}'

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

const data = await response.json();

import requests

response = requests.post(
    'https://spaces.nexudus.com/api/support/helpdeskcomments',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'HelpDeskMessageId': 0,
        'CoworkerId': 0,
        'MessageText': ''
    }
)

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 helpdeskcomment was created successfully.

array

null on success.

Example Response

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

Create HelpDeskComment

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

import requests

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

payload = {
    "HelpDeskMessageId": 123,
    "CoworkerId": 123,
    "MessageText": "<string>"
}
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({HelpDeskMessageId: 123, CoworkerId: 123, MessageText: '<string>'})
};

fetch('https://spaces.nexudus.com/api/support/helpdeskcomments', 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

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400

​Authentication

​Request Body

​Required Fields

​Optional Fields

​Code Examples

​Response

​200

​400

Authentication

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400