API endpoint to delete records by ID.
Note: Deleted records cannot be restored.
Note: This API documentation is intended to give the reader an overview of the APIs capabilities and how to access them. When trying to write API calls, we strongly recommend you use the API documentation directly associated with the specific API key you will be calling. That documentation includes examples with the actual IDs of the form and form elements, includes examples for each field available in the associated forms etc. This will allow direct copy-paste of the code snippets from the documentation into your code. If you were to try and use the examples in this documentation, you would have to modify them for the fields, form ID, etc.
HTTP request
DELETE https://api.gwapps.com/v1/forms/formId/records
Parameters
| Parameter | Description | Type |
|---|---|---|
| Required path parameters | ||
| formId | The current formId 66b18359dc7659dc4cb98d15 | string |
| Required query parameters | ||
| ids | List separated by comma for the records id that are going to be removed | string |
Example Request
DELETE https://api.gwapps.com/v1/forms/66b18359dc7659dc4cb98d15/records?ids=recordId1,recordId2
Response
If the operation was completed successfully it will return a 200 http status code.
Example Response
{
"kind": "form#record",
"code": 200,
"message": "success"
}
Related API Articles
This article covers details for a specific API call/endpoint. Details of the overall Records API structure and calls/endpoints can be found in the GW Apps Records API article. Information on creating API Keys can be found within the API section of the Platform Settings, and in the Security > API Keys section of Edit App within each application.