Post
/api/v1/custom-sounds.delete
Delete a custom sound from the workspace by its _id. This also removes the associated audio file from storage. This endpoint replaces the deprecated DDP method deleteCustomSound, which now logs a deprecation warning and is scheduled for removal in 9.0.0.
Permission required: manage-sounds
Changelog
| Version | Description |
|---|---|
| 8.6.0 | Added |
Header parameters
X-Auth-Token
stringRequired
The authToken of the authenticated user.
ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired
The userId of the authenticated user.
ExamplerbAXPnMktTFbNpwtJ
Body parameters
Example
{
"_id": "65462caea2f73c7460e18f83"
}object
_id
string Required
The ID of the custom sound to delete. Must be at least one character long.
Example65462caea2f73c7460e18f83
Responses
200
OK
Success
{
"success": true
}object
success
boolean
400
Bad Request
Invalid sound
{
"success": false,
"error": "Custom_Sound_Error_Invalid_Sound"
}Missing required field
{
"success": false,
"error": "must have required property '_id' [invalid-params]",
"errorType": "invalid-params"
}object
success
boolean
error
string
errorType
string
401
Unauthorized
Authorization Error
{
"status": "error",
"message": "You must be logged in to do this."
}object
status
string
message
string
403
Forbidden
Permission Error
{
"success": false,
"error": "User does not have the permissions required for this action [error-unauthorized]",
"errorType": "error-unauthorized"
}object
success
boolean
error
string
errorType
string