DELETE Audio
Overview
The following table contains important information about the DELETE
method for managing the process of removing the specific Audio.
DELETE Audio | |
---|---|
Method | DELETE |
URL or Endpoint | /api/v1/projectId /audios |
Headers | Authorization |
Parameters | projectId |
Request Body | ids |
The description of the URL parameter is as follows:
projectId Parameter | |
---|---|
URL Parameter Name | projectId |
Mandatory | Yes |
Type | string |
Description | Unique Id of the project. |
Request Body
{
"ids": [
"string"
]
}
Information about the fields that appear on the request body are displayed in the table below.
Parameter Name | Mandatory | Type | Description |
---|---|---|---|
Ids | Yes | string | Unique identifier of the specific audio |
Response
{
"success": true,
"errors": [],
"messages": [],
"result": {
"ids": [
"{audioId}"
]
},
"resultInfo": null,
"statusCode": 200
}
Information about the fields that appear when you receive the response are displayed in the table below.
Field Name | Type | Description |
---|---|---|
success | bool | If the response is successful it will return true. Otherwise will return false |
errors | array[] | Indicates if there was an error |
messages | array[] | Returns the response message from back-end |
result | array[Object] | Returns the response object |
ids | array[] | Returns unique identifiers of the deleted audios. |
resultInfo | string | Returns extra information about the result |
statusCode | integer($int32) | Returns the HTTP Status Code |
If the action is successful, the service sends back an HTTP 200 or 201 response.
Errors
For information about the errors that are common to all actions, see Common Errors:
HTTP Status Code 400: Bad Request
HTTP Status Code 401: Unauthorized
HTTP Status Code 403: Forbidden
HTTP Status Code 404: Result Not Found
HTTP Status Code 500: Internal Server Error
HTTP Status Code 503: Backend Fetch Failed