This request method allows you to delete a list of tasks by specifying their task IDs.
This API is available on the Cloud via an 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/task/search?format=xml/json
You may use either JSON or XML formats in your DELETE submission.
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/task/search | Model Description/Schema & Parameters |
Parameters
The DELETE verb used against the /api/v2/task/search API endpoint allows you to return details of the specified task matching the given criteria.
The required and optional parameters for this DELETE call to the Task API are outlined below.
| Name | Type | Description | Required |
|---|---|---|---|
| TaskIds | String | A comma-separated list of string values containing Task Ids to Delete. (Up to a max of 100 per request) | ✓ |
| CompanyId | Integer | Your unique company identifier | ✓ |
| IntegrationKey | String | Your unique integration key | ✓ |
| PurgeDays | Integer | The number of days the tasks will be stored in the trash before being permanently deleted (Enter between 1 and 30). The default value, if left blank, is 30 days. |
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.
Request URL
https://eforms.mobileform.net:443/api/v2/task/search?TaskIds=43XXXXXXXXXXXXXXXXXXXXXXXXXX%2C69XXXXXXXXXXXXXXXXXXXXXXXXXXXXX&CompanyId=XXXXX&IntegrationKey=caXXXXXXXXXXXXXXXXXXXXXXXXXXResponse Body
{}