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 customer file is a document attached to a customer’s record that can remain internal, be shared through the Members Portal, or be sent for digital signature.

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

ID of the location this customer file belongs to; it is supplied from the admin context when creating the record..

integer

required

ID of the customer this file belongs to..

string

required

Required name displayed for the customer file or document..

Optional Fields

string

Optional notes for the customer file; included in the notification sent when a new file is shared or sent for signature..

boolean

Whether the customer can view and download the file in the Members Portal; creating a shared file sends the new-file notification..

boolean

Whether to request a digital signature from the customer; requires a portal-enabled customer, enabled Dropbox Sign integration, and valid signatories..

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 for the stored document, such as .pdf, .docx, or .jpg..

boolean

Whether the location has billed for this file’s digital signature request..

string

Opaque identifier assigned by the digital signature provider to track this document; it is managed automatically..

string

Unique ID of the document template used to generate the file; required when CoworkerContractGuid is set..

string

Email address to notify after the customer signs; when omitted for a signature request, it defaults to the creating user’s email when available..

string

Unique ID of the proposal this file supports; proposal workflows use it to locate their generated documents..

string

Unique ID of the customer’s contract used to generate a contract document; requires DocumentTemplateGuid..

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
}

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