Skip to main content
POST
/
api
/
audioplayback
/
updateAudioUploadMetadata
Update audio upload metadata
curl --request POST \
  --url https://api2.rhombussystems.com/api/audioplayback/updateAudioUploadMetadata \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "audioUploadUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "newDescription": "Updated welcome message for visitors",
  "newDisplayName": "Updated Welcome Message"
}
'
{
  "error": true,
  "errorMsg": "<string>",
  "warningMsg": "<string>"
}

Authorizations

x-auth-apikey
string
header
required

Your API key for Rhombus.

Headers

x-auth-scheme
string
default:api-token
required

Authentication scheme indicator ("api-token").

Required string length: 9

Body

application/json

Request to update audio upload metadata.

audioUploadUuid
string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

newDescription
string | null

New description for the audio clip

Example:

"Updated welcome message for visitors"

newDisplayName
string | null

New display name for the audio clip

Example:

"Updated Welcome Message"

Response

200 - application/json

OK

Response from updating audio upload metadata.

error
boolean | null
errorMsg
string | null
warningMsg
string | null