Create CoworkerDataFile

POST

api

spaces

coworkerdatafiles

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

import requests

url = "https://spaces.nexudus.com/api/spaces/coworkerdatafiles"

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

fetch('https://spaces.nexudus.com/api/spaces/coworkerdatafiles', 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 CoworkerDataFile is a file attached to a customer’s record. Files can be kept internal or shared with the customer on the Members Portal. When a file is shared (AvailableToUser = true), the customer receives an email notification and can view or download the file from the Files tab under My Activity on the Members Portal. You can request a digital signature (RequestDigitalSignature = true) — once the customer signs the document, a signed copy is automatically stored in SignedFileDataFileName. The notes in Description are included in the email notification sent to the customer. Supported formats include .pdf, .docx, .xlsx, .jpg, .png, and other common types (max 10 MB). Files can be linked to a document template, a proposal, or a coworker contract via the respective GUID fields.

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

Request Body

Required Fields

integer

required

Location ID.

integer

required

ID of the customer this file belongs to.

string

required

Name of the file or document.

Optional Fields

string

Notes included in the email notification sent to the customer when the file is shared.

boolean

Whether the file is shared with the customer and visible on the Members Portal.

boolean

Whether to request a digital signature from the customer.

string

URL of a new file to upload (replaces the existing file).

boolean

Set to true to remove the existing uploaded file.

string

URL of a new signed file to upload (replaces the existing signed copy).

boolean

Set to true to remove the existing signed copy.

string

File extension (e.g. pdf, docx, jpg).

boolean

Whether the customer has been billed for this file.

boolean

Whether the customer has signed this document.

string

Identifier used by the digital signature provider to track this document.

string

GUID of the document template used to generate this file.

string

Email address to notify when the customer signs the document.

string

GUID of the proposal linked to this file.

string

GUID of the coworker contract linked to this file.

Code Examples

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

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

const data = await response.json();

import requests

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

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

array

null on success.

Example Response

{
  "Status": 200,
  "Message": "CoworkerDataFile 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 CoworkerDataFileUpdate an existing CoworkerDataFile record.

Create CoworkerDataFile

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

import requests

url = "https://spaces.nexudus.com/api/spaces/coworkerdatafiles"

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

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