Create CoworkerTask

POST

api

crm

coworkertasks

Create CoworkerTask

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

import requests

url = "https://spaces.nexudus.com/api/crm/coworkertasks"

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

fetch('https://spaces.nexudus.com/api/crm/coworkertasks', 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 task is an operational to-do item for a customer, assigned to an admin user with optional due-date email reminders and visibility to the wider admin team.

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

Request Body

Required Fields

integer

required

ID of the location that owns this task..

integer

required

ID of the customer this task concerns..

string

required

Required task title..

integer

required

ID of the admin user responsible for completing this task; required when creating a task..

Optional Fields

string

Optional instructions or context for completing the task..

string

Internal correlation GUID for the task-list item that created this task; managed by the originating workflow..

boolean

Whether the task is complete; completed tasks are excluded from reminder processing and each user’s active-task list..

string

Optional due date and time stored in UTC; an email reminder becomes eligible at or after this time when notifications are enabled..

boolean

Internal flag indicating that the due-date email reminder was queued; task updates reset it to false..

boolean

Whether to send the responsible admin an email reminder once the due date is reached; no reminder is sent without a due date..

boolean

Whether the task appears in every admin user’s active-task list instead of only the responsible admin’s list..

Code Examples

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

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

const data = await response.json();

import requests

response = requests.post(
    'https://spaces.nexudus.com/api/crm/coworkertasks',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'BusinessId': 0,
        'CoworkerId': 0,
        'Name': '',
        'ResponsibleId': 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 coworkertask was created successfully.

array

null on success.

Example Response

{
  "Status": 200,
  "Message": "CoworkerTask 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 CoworkerTask

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

import requests

url = "https://spaces.nexudus.com/api/crm/coworkertasks"

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

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