Skip to navigation
API ReferenceTask Recurrency

Delete Recurring Tasks

Removes one or more instances of a Recurring Task based on the option you specify: this means to remove a single instance, all means to remove all instances, or future means to remove all future instances of the Recurring Task.

A Recurring Task is one that must be completed on a specific regular frequency, such as Daily, Weekly, Monthly, or Yearly. To create a Recurring Task, you must first create a regular Task with the necessary information, then call one of the Create Recurring Task APIs. To remove an instance of a Recurring Task, call Delete Recurring Task and specify one or more instances of the Recurring Task.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

taskIdstringRequiredformat: "uuid"
The unique identifier of the Task
optionstringRequired

Specify this, all, or future to indicate which task recurrnces to delete.

Headers

x-integration-namestringOptional
The name of the calling system passed along as a header parameter

Response

Success
errorobject or nullOptional
If the API call failed, this will contain information about the error that occurred.
successbooleanOptionalRead-only

True if the API call succeeded; false otherwise.

hasErrorbooleanOptionalRead-only
True if the API call failed.
statusCodeenumOptional
The HTTP code of the response.
dataobjectOptional
Returns the id of a specific ChangeSet