Delete Request

4min

Delete Request
Requests can be deleted by making an  HTTP DELETE request to the  /collections/COLLECTION_ID/REQUEST_ID endpoint (where  REQUEST_ID is the  id of the Request to delete and  COLLECTION_ID is the  id of the Collection the Request belongs to).
Collection Status
Requests can only be deleted from a Collection when it is not running. To check whether a Collection is currently running use the Get Collection endpoint.
Deleting Multiple Requests
You should make calls to the Delete Request endpoint sequentially, rather than in parallel, as it is designed to remove Requests one by one. If you make too many concurrent calls you will receive an  HTTP 429  error. For mass-delete operations consider deleting and re-creating the Collection as this is typically quicker.
Alternatively if your use-case requires mass deletion of Requests you may make an  HTTP DELETE  request to the  /collections/COLLECTION_ID/requests  endpoint with the  Content-Type  HTTP header set to  application/json  and the body of the request being an array of Request ID strings. The platform will then delete each of the IDs specified.
﻿
Example
﻿DELETE  /collections/COLLECTION_ID/REQUEST_ID
In the example below we delete a Request with  id=ABCDEFGHIJKLMNOP from Collection with  id=123456 :
Curl
Node.js
Python
PHP
$ curl -X DELETE "https://api.backyardapi.com/collections/123456/ABCDEFGHIJKLMNOP?api_key=demo"
$ curl -X DELETE "https://api.backyardapi.com/collections/123456/ABCDEFGHIJKLMNOP?api_key=demo"
﻿
Backyard API responds with a JSON object confirming that the Request has been deleted, or detailing the error if it has not been possible to delete the Request:
✅ Success JSON
❌ No Request
❌ No Collection
{
  "request_info": {
    "success": true,
    "message": "Request deleted"
  }
}
{
  "request_info": {
    "success": true,
    "message": "Request deleted"
  }
}
﻿
﻿
Next Steps
     Update Request
     List Request﻿

Updated 08 Aug 2024

Did this page help you?

Update Request

Clear Requests