Description

Sets a recurrence pattern for a task. Valid values of repeat are detailed here.

Availability

Available in versions 1 and 2.

Authentication

This method requires authentication with write permissions.

Timeline

This method requires a timeline.

Revertable

The effects of this method can be undone.

Arguments

api_key (Required) 1 2

Your API application key. See here for more details.

timeline (Required) 1 2

The timeline within which to run a method. See here for more details.

list_id (Required) 1 2

The id of the list to perform an action on.

taskseries_id (Required) 1 2

The id of the task series to perform an action on.

task_id (Required) 1 2

The id of the task to perform an action on.

repeat 1 2

The recurrence pattern for a task. Valid values of repeat are detailed here. An empty value unsets any existing recurrence pattern.

Example Response

<list id="387546">
  <taskseries id="648042" created="2015-05-07T10:19:54Z" modified="2015-05-07T11:11:22Z"
             name="Get Coffee" source="api">
    <rrule every="1">FREQ=DAILY;INTERVAL=1</rrule>
    <tags/>
    <participants/>
    <notes/>
    <task id="811467" due="2015-05-09T14:00:00Z" has_due_time="0" added="2015-05-07T10:19:54Z"
         completed="" deleted="" priority="3" postponed="1" estimate="2 hrs"/>
  </taskseries>
</list>

Error Codes

96 Invalid signature

The passed signature was invalid.

97 Missing signature

The call required signing but no signature was sent.

98 Login failed / Invalid auth token

The login details or auth token passed were invalid.

99 User not logged in / Insufficient permissions

The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions.

100 Invalid API Key

The API key passed was not valid or has expired.

105 Service currently unavailable

The requested service is temporarily unavailable.

114 Invalid SOAP envelope

The SOAP envelope sent in the request could not be parsed.

115 Invalid XML-RPC Method Call

The XML-RPC request document could not be parsed.

120 Method not valid for requested version

The requested method is not compatible with the requested version.

300 Timeline invalid or not provided

No timeline provided / Timeline invalid.

320 list_id invalid or not provided

No list_id provided / list_id invalid.

340 taskseries_id/task_id invalid or not provided

No taskseries_id or task_id provided / taskseries_id or task_id invalid.

3040 List is read-only.

Tried to perform action in read-only list.

4040 Sub-task only editable by Pro accounts

Non-pro account tried to update sub-task.

4070 Repeating task exists in hierarchy

Repeating sub-tasks may not have repeating ancestors and vice versa.