AudioFiles
Update AudioFile
Update an existing AudioFile record.
PUT
Update AudioFile
Updates an existing AudioFile record. You must include the
Id of the record to update along with all required 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 AudioFile-Edit role.Request Body
Required Fields
integer
required
The Id of the AudioFile record to update.
integer
required
ID of the business linked to this record.
string
required
Name of the audio file.
Optional Fields
string
Description of the audio file.
string
URL of a new file to upload as the audio.
boolean
Set to true to remove the current audio file.
integer
File size in bytes.
Code Examples
Response
200
integer
HTTP status code.
200 on success.string
A human-readable message confirming the update.
object
Contains the
Id of the updated record.boolean
true if the audiofile was updated 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
Update AudioFile