The DELETE Folder API allows you to remove an existing folder from a company account.
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/folder?format=xml/json
You may use either JSON or XML formats in your DELETE request.
You indicate this by setting the ContentType HTTP header as “application/json” or “application/xml”.
If no ContentType is specified, XML format is assumed.
All XML formatted requests must specify the following XML namespace in the data source root element: xmlns:i=”http://www.w3.org/2001/XMLSchema-instance”
Endpoints & API Explorer
| Node | API Endpoint | API Explorer |
|---|---|---|
| US | api/v2/folder | Model Description/Schema & Parameters |
Parameters
The required parameters for a PUT request to the Screens 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. | ✓ |
| Id | String | The Folder’s unique identifier. | ✓* |
| Name | String | Name of the folder you’d like to delete. | ✓* |
| ExternalId | String | ExternalId of the folder you’d like to delete. | ✓* |
✓* – At least one of these values must be specified (Id, Name or ExternalId)
Example
Given that the API is REST-based, you can access the API directly via your web browser to test or by using Postman API Platform.
The below example demonstrates how to delete an existing folder using a DELETE Folder API call.
Request URL
https://eforms.mobileform.net:443/api/v2/folder?CompanyId=6XXXX&IntegrationKey=995XXXXXXXXXXXXXXXXXXXXXXX&Name=Test%20App%203Response Body
{}Response Code
200