Update AudioFile

Update an existing AudioFile record.

PUT /api/content/audiofiles

Update AudioFile

cURL

curl --request PUT \
  --url https://spaces.nexudus.com/api/content/audiofiles \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "Id": 123,
  "BusinessId": 123,
  "Name": "<string>"
}
'

import requests

url = "https://spaces.nexudus.com/api/content/audiofiles"

payload = {
    "Id": 123,
    "BusinessId": 123,
    "Name": "<string>"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({Id: 123, BusinessId: 123, Name: '<string>'})
};

fetch('https://spaces.nexudus.com/api/content/audiofiles', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

200

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

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

Id · integer · required

The Id of the AudioFile record to update.

BusinessId · integer · required

ID of the business linked to this record.

Name · string · required

Name of the audio file.

Optional Fields

Description · string

Description of the audio file.

NewAudioUrl · string

URL of a new file to upload as the audio.

ClearAudioFile · boolean

Set to true to remove the current audio file.

FileSizeBytes · integer

File size in bytes.

Code Examples

cURL

curl -X PUT \
  "https://spaces.nexudus.com/api/content/audiofiles" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "BusinessId": 0,
    "Name": "",
    "Id": 87654321
}'

const response = await fetch(
  'https://spaces.nexudus.com/api/content/audiofiles',
  {
    method: 'PUT',
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      BusinessId: 0,
      Name: '',
      Id: 87654321
    })
  }
);

const data = await response.json();

import requests

response = requests.put(
    'https://spaces.nexudus.com/api/content/audiofiles',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'BusinessId': 0,
        'Name': '',
        'Id': 87654321
    }
)

data = response.json()

Response

200

Status · integer

HTTP status code. 200 on success.

Message · string

A human-readable message confirming the update.

Value · object

Contains the Id of the updated record.

WasSuccessful · boolean

true if the audiofile was updated successfully.

Errors · array

null on success.

Example Response

{
  "Status": 200,
  "Message": "AudioFile was successfully updated.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "UpdatedBy": "[e-mail]",
  "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.

Show child attributes

AttemptedValue · any

The value that was submitted for the field, or null if missing.

Message · string

The validation error message.

PropertyName · string

The name of the property that failed validation.

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
}