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 CoworkerTask represents a to-do item that can be assigned to an admin user. Tasks help space managers and staff track daily operations such as onboarding steps, maintenance requests, or follow-ups. Each task is linked to a customer (CoworkerId) and assigned to a responsible admin (ResponsibleId). The responsible admin receives a notification on the Admin Panel and can mark the task as completed once done. Tasks can optionally be grouped into task lists (TaskListName). Task lists standardise and partially automate admin processes — for example, a series of onboarding tasks (access card handout, locker keys, welcome tour) each assigned to a different admin. Use NotifyByEmail to send an email reminder to the responsible admin when the task is due. Use DisplayToEveryone to make the task visible to all admin users, not just the responsible one.

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 business linked to this record.

integer

required

ID of the coworker linked to this record.

string

required

Task name.

integer

required

ID of the responsible linked to this record.

Optional Fields

string

Additional details or instructions for the task.

string

Unique identifier of the task item within a task list.

boolean

Whether the task has been marked as completed.

string

Due date for the task (UTC).

boolean

Whether a reminder has been sent for this task.

boolean

Whether to notify the responsible admin by email when the task is due.

boolean

Whether the task is visible to all admin users.

string

Due date for the task in the location’s local timezone.

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
}

Update CoworkerTaskUpdate an existing CoworkerTask record.

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