DELETE Task (Search)

DELETE Task (Search)

TABLE OF CONTENTS


This request method allows you to delete an existing task.  

This API is available via SSL-secured HTTPS connection on the Cloud using the REST DELETE verb.
The format query string parameter controls the desired response format. Specify either XML or JSON.


/api/v2/task?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"

Parameters

The DELETE verb allows you to delete an existing task.
The required and optional parameters for a DELETE call to the Task API are outlined below.


NameTypeDescriptionRequired
TaskIdsStringA comma-separated list of string values containing Task IDs to Delete. (Up to a max of 100 per request)✓
CompanyIdIntegerYour unique Company ID is found on the Organization Setup page of the secure website.✓
IntegrationKeyStringYour unique Integration Key is found on the Organization Setup page of the secure website.✓
PurgeDaysIntegerThe 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 the Postman API Platform.


Request URL

https://eformsmobile.com:443/api/v2/task?Id=bffXXXXXXXXXXXXXXXXXXXXXXXXXX&CompanyId=6XXXX&IntegrationKey=995XXXXXXXXXXXXXXXXXXXXXXXXX
SQL


Response Body

{}


    • Related Articles

    • DELETE Bulk Tasks

      TABLE OF CONTENTS API Explorer Required Parameters App Example If you're looking to delete multiple tasks without needing to log into the web portal via our Tasks & Dispatch menu area, similar functionality can be achieved using our exposed API ...

    • GET Task (Search)

      TABLE OF CONTENTS Parameters Example Additional Info API Explorer This request method allows you to find all tasks matching the given criteria. On the Cloud, this API is available via SSL-secured HTTPS connection using the REST GET verb. The format ...

    • POST Task

      TABLE OF CONTENTS Parameters Example This request method allows you to create a new task and assign it to a specified user(s). On the Cloud, this API is available via SSL-secured HTTPS connection using the REST POST verb. The format query string ...

    • PUT Task

      TABLE OF CONTENTS Parameters Example This request method allows you to update an existing task. This API is available via SSL-secured HTTPS connection on the Cloud using the REST PUT verb. The format query string parameter controls the desired ...

    • GET Usergroup (Search)

      TABLE OF CONTENTS Parameters Example This API allows you to find all user groups matching the given parameters. This API is available via SSL-secured HTTPS connection on the Cloud using the REST GET verb. The format query string parameter controls ...