ONontraport
tasks

Cancel a set of Tasks

To affect a single Task or list of specific Tasks, use the <strong>ids</strong> array in the <strong>criteria</strong> parameter. Otherwise, you should use <strong>performAll</strong> and other criteria to select a Group of Tasks to cancel.

post/task/cancel

Request

  • Base URL
    https://api.ontraport.com/1
  • Auth
    none declared

Request body

objectIDinteger required
idsinteger[]
conditionstring

See the Criteria examples below

sortstring

Field used to sort results

sortDir'asc' | 'desc'

Sort direction, must be used in conjunction with <b>sort</b> parameter.

rangeinteger

Number of results to return (maximum=50)

startinteger

Return results starting at this offset

group_idinteger

Group ID as an integer

searchstring

Search Objects for this string

searchNotesstring

Boolean flag to additionally search Object Notes for the Search term given in Search parameter

externsstring

External fields to include in results

listFieldsstring[]

Return only these fields in the response

event_idinteger

Optional parameter for calendar event composite ID

Response

Successfully canceled tasks

codeinteger required
dataobject required
account_idinteger required

Changes

No recorded changes to this operation across all 5 revisions of this API.