Skip to main content
POST
/
api
/
crm
/
tasklists
Create TaskList
curl --request POST \
  --url https://spaces.nexudus.com/api/crm/tasklists \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "BusinessId": 123,
  "Name": "<string>"
}
'
{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}
A TaskList groups related task items into a named collection for organisation and tracking purposes.

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

Request Body

Required Fields

BusinessId
integer
required
ID of the business linked to this record.
Name
string
required
The name value for this task list.

Optional Fields

Active
boolean
Whether this task list is currently active.
Tariffs
integer[]
List of tariffs linked to this record.
AssignToNewContacts
boolean
Whether assign to new contacts is enabled.
AssignToNewMembers
boolean
Whether assign to new members is enabled.
AssignToCancellations
boolean
Whether assign to cancellations is enabled.

Code Examples

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

Response

200

Status
integer
HTTP status code. 200 on success.
Message
string
A human-readable message confirming the creation.
Value
object
Contains the Id of the newly created record.
WasSuccessful
boolean
true if the tasklist was created successfully.
Errors
array
null on success.
Example Response
{
  "Status": 200,
  "Message": "TaskList 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

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.
WasSuccessful
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
}