TABLE OF CONTENTS

  • Parameters
  • Example


ADDITIONAL INFO

  • API Explorer
  • General Information

 

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.


 

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 ID is found on the Organization Setup page of the secure website.

 		 

✓

 
 

IntegrationKey

 		 

String

 		 

Your unique Integration Key is found on the Organization Setup page of the secure website.

 		 

✓

 
 

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 the Postman API Platform.


 

Request URL

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

 

Response Body

{}