Skip to main content
POST
/
api
/
content
/
datafiles
Create DataFile
curl --request POST \
  --url https://spaces.nexudus.com/api/content/datafiles \
  --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 DataFile stores a general-purpose file that can be referenced in the members portal, invoices, or email messages and templates sent to customers. URLs for stored files are public. Use NewFileDataUrl to attach a file from a URL during create or update, and ClearFileDataFile to remove the currently attached file.

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

Request Body

Required Fields

BusinessId
integer
required
Business Id.
Name
string
required
Display name of the file.

Optional Fields

Description
string
Optional description of the file.
NewFileDataUrl
string
Public URL pointing to the file to upload. Set during create or update to attach a new file.
ClearFileDataFile
boolean
Set to true to remove the currently attached file.
FileSizeBytes
integer
Size of the uploaded file in bytes.

Code Examples

curl -X POST \
  "https://spaces.nexudus.com/api/content/datafiles" \
  -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 datafile was created successfully.
Errors
array
null on success.
Example Response
{
  "Status": 200,
  "Message": "DataFile 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
}