Delete A Listing
This endpoint delets a listing with the provided ID.
Allows for a listing to be immediately deleted or to be scheduled for deletion.
All date fields included in the body parameters need to be specified as ISO8601-formatted date strings.
Date fields should follow a “YYYY-MM-DD” format.
Header
The authentication token for your request
Path
The id of the listing to be deleted
Body
The date at which the listing should be deleted.
If left empty, it defaults to the current date
Response
Indicates whether the listing has been succesfully scheduled for deletion or not.
The id of the listing scheduled for deletion.
Errors
Listed below are common errors that may be returned by the endpoint, along with their corresponding status code.
Status Code - 400
{
"error": {
"type": "missing_authorization",
"message": "Your request does not include an 'Authorization' header with a bearer token for your account."
}
}
Status Code - 401
{
"error": {
"type": "expired_token",
"message": "The bearer token you have provided in the 'Authorization' header has expired. Please obtain a new one."
}
}
Status Code - 401
{
"error": {
"type": "invalid_authorization",
"message": "The bearer token you have provided in the 'Authorization' header is invalid."
}
}
Status Code - 401
Returned if the currently authenticated user does not have permission to delete the listing they are attempting to delete
{
"error": {
"type": "not_authorized",
"message": "The user you have authenticated as is not authorized to delete the listing you are attempting to delete."
}
}