This request method allows you to delete an existing recurring task.
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/taskrecurring?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/taskrecurring | Model Description/Schema & Parameters |
Parameters
The DELETE verb allows you to delete an existing recurring task.
The required and optional parameters for a DELETE call to the Task Recurring API are outlined below.
| Name | Type | Description | Required |
|---|---|---|---|
| Id | String | The Recurring Task’s unique identifier | ✓ |
| CompanyId | Integer | Your unique Company Id is found on the Organisation Setup page of the secure website. | ✓ |
| IntegrationKey | String | Your unique Integration Key is found on the Organisation Setup page of the secure website. | ✓ |
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/api/v2/taskrecurring?Id=73bed32a34be49b4bf4db23c0037df73&CompanyId=6XXXX&IntegrationKey=24XXXXXX