The DELETE Formentry API allows you to delete an existing form entry.
On the Cloud, this API is available via SSL-secured HTTPS connection using the REST DELETE verb. The format query string parameter controls the desired response format. Specify either XML or JSON.
/api/v2/formentry?format=xml/json
Endpoints & API Explorer
| Node | API Endpoint | API Explorer |
|---|---|---|
| US | api/v2/formentry | Model Description/Schema & Parameters |
Parameters
The DELETE verb allows you to delete a specific form entry.
The required and optional parameters for a DELETE call to the Formentry API are outlined below.
| Name | Type | Description | Required |
|---|---|---|---|
| CompanyId | Integer | Your unique Company Id found on the Organisation Setup page of the secure website | ✓ |
| IntegrationKey | String | Your unique Integration Key found on the Organisation Setup page of the secure website. | ✓ |
| AnswerFormat | String | Whether or not to return rich answers or raw answers | |
| Id | String | The Form Entry’s unique identifier | ✓ |
| MediaAsUrl | Boolean | Returns Media answers as full file download URLs instead of just the file name | |
| Fields | String | Optionally restrict returned answer values to the given comma-separated list of field data names.ONLY SUPPORTED WITH ‘FLAT’ ANSWERFORMAT. | |
| PurgeDays | Integer | Number of days the Form Entry will be stored in trash before being permanently deleted (Enter between 1 and 30). Default value if left blank is 30 days. |
Example
Given that the API is REST-based, you can access the API directly using a REST client such as Postman, a popular standalone application for testing APIs.
Request URL
https://eforms.mobileform.net:443/api/v2/formentry?AnswerFormat=Raw&CompanyId=XXXXX&IntegrationKey=a17a9bb385074a7591XXXXXXXX&&&&Response Code
A response code of 200 means that the entry was successfully deleted.