DataFiles
Create DataFile
Create a new DataFile record.
POST
Create DataFile
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
ID of the business linked to this record.
Display name of the file.
Optional Fields
Optional description of the file.
Public URL pointing to the file to upload. Set during create or update to attach a new file.
Set to true to remove the currently attached file.
Size of the uploaded file in bytes.
Code Examples
Response
200
HTTP status code.
200 on success.A human-readable message confirming the creation.
Contains the
Id of the newly created record.true if the datafile was created successfully.null on success.Example Response
400
A summary of the validation error(s), in the format
PropertyName: error message.null on validation failure.Array of validation errors.
false when the request fails validation.Example Response
Create DataFile