Create HelpDeskDepartment

POST

api

support

helpdeskdepartments

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

import requests

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

payload = {
    "BusinessId": 123,
    "Name": "<string>",
    "Description": "<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({BusinessId: 123, Name: '<string>', Description: '<string>'})
};

fetch('https://spaces.nexudus.com/api/support/helpdeskdepartments', 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 support department (HelpDeskDepartment) routes customer support tickets to its managers and can add a task list to the customer.

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

Request Body

Required Fields

integer

required

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

string

required

Required localized name used to identify this support department when assigning support tickets..

string

required

Required localized text explaining the purpose or scope of this support department..

Optional Fields

boolean

Whether customers can select this support department when submitting a support ticket; inactive departments are not offered to customers..

integer[]

List of user IDs for managers notified about new tickets and comments assigned to this support department..

integer

Optional ID of the task list automatically added to the customer when a ticket is created or updated for this support department..

Code Examples

curl -X POST \
  "https://spaces.nexudus.com/api/support/helpdeskdepartments" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "BusinessId": 0,
    "Name": "",
    "Description": ""
}'

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

const data = await response.json();

import requests

response = requests.post(
    'https://spaces.nexudus.com/api/support/helpdeskdepartments',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'BusinessId': 0,
        'Name': '',
        'Description': ''
    }
)

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

array

null on success.

Example Response

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

Create HelpDeskDepartment

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

import requests

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

payload = {
    "BusinessId": 123,
    "Name": "<string>",
    "Description": "<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({BusinessId: 123, Name: '<string>', Description: '<string>'})
};

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