Delete form
Description
The method deletes a form. If necessary, you can delete only the collected data while keeping the form itself.
URL
Method: POST
https://example.com/api/v1.1/forms/delete
Request Parameters
Request body (application/json):
| Parameter | Type | Example | Required | Description |
|---|---|---|---|---|
| token | string | a1b2c3d4e5f67890abcdef1234567890 | Yes | API token |
| id | integer | 1 | Yes, if shortname is not specified | Form ID |
| shortname | string | form_6Ven2v7O | Yes if id is not specified | Form short name |
| data_only | boolean | false | No | If true — only form fill data (forms_data) is deleted, the form itself is preserved. Default — false (complete form and data deletion) |
Request Example
- JSON
- XML
{
"token": "a1b2c3d4e5f67890abcdef1234567890",
"id": 1,
"data_only": false
}
<xml>
<token>a1b2c3d4e5f67890abcdef1234567890</token>
<id>1</id>
<data_only>false</data_only>
</xml>
Response Example
- JSON
- XML
{
"error": 0,
"error_text": "Successful operation"
}
<xml>
<error>0</error>
<error_text>Successful operation</error_text>
</xml>
Response Parameters
| Parameter | Type | Description |
|---|---|---|
| error | integer | Error code |
| error_text | string | Error text |