Skip to main content
POST
Create VideoFile
A VideoFile represents an uploaded video stored in the system. Video files can be used in courses, community content, or other areas of the platform.

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

Request Body

Required Fields

integer
required
ID of the business linked to this record.
string
required
The name value for this video file.

Optional Fields

string
Free-text description of this video file.
string
URL of a new file to upload as the video.
boolean
Set to true to remove the current video file.
integer
The file size bytes value for this video file.

Code Examples

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 videofile was created successfully.
array
null on success.
Example Response

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.
boolean
false when the request fails validation.
Example Response