Set up an API DELETE request
The Data Collections allows you to create API requests to any database or tool with an available REST API.
Here is how to create a DELETE request to delete data in the external data source from your app.
Example Database
Copy this Airtable as the database to delete data: https://airtable.com/shrWs599TQVT14tCJ
We will follow Airtable's API documentation to set up the DELETE request below
Airtable API documentation for DELETE request
1. In Data Library, click
+ New Collection and select Custom API.- If you're adding this request to an existing collection, skip to Step 3
To add a request to an existing collection created by the API Wizard, click on Advanced view to enter Custom API mode.
2. Enter the name of your collection and an optional description (we recommend putting the data source as the description, like Google Sheet).
A Collection is a group of API requests, usually for the same data source.
3. Edit the request name to help you identify it. Then change the request type to
DELETE.
4. Input the DELETE request URL from the API of your choosing.
In our example, we will take the DELETE request for a single record shown in the Airtable API documentation.
5. Then, replace the single record ID at the end of the URL with
${id}. This will allow the request to delete whichever record the user selects.
6. The API documentation will specify the Headers you also need to enter the DELETE request. In our example, we'll show what Airtable requires.
For Header: **
H "Authorization: Bearer YOUR_API_KEY"
Airtable DELETE request: Header input. (Remember to replace with your actual API key)
7. For Parameters: we will input the data record id from the GET request, so that the DELETE request links itself to the remote data retrieved from the GET request.
- Key:
id - Value: data record ID from the GET request
Locate the data record ID in the GET request. Select it in "Received Data" if you haven't. Make sure the "Label" is changed to id so it matches the DELETE request URL + Parameters.
8. Press
Send. You have successfully set up the DELETE request if: a. You receive a response list under Received Data.
b. The first record in your data source is deleted.
If you encounter any error message after clicking Send, screenshot it and post in the Bravo community or message us via the
? widget (for Olé and Bravissimo users).Last modified 1yr ago