rtm.tasks.add
Description
Adds a task, name
, to the list specified by list_id
.
If list_id
is omitted, the task will be added to the Inbox.
If parse
is 1
, Smart Add
will be used to process the task.
If parent_task_id
is provided and the user has a Pro account, the new task is created
as a sub-task, with the list of the parent_task_id
taking priority over the provided
list_id
.
Availability
Available in versions 1 and 2.
Authentication
This method requires authentication with write permissions.
Timeline
This method requires a timeline.
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
1 2- The id of the list to perform an action on.
name
(Required) 1 2- The desired task name.
parse
1 2- Specifies whether to process
name
using Smart Add. parent_task_id
2- Id of parent task if creating sub-task (Pro accounts only).
external_id
1 2- External id that an app can attach to the task.
give_to
1 2- The id of the contact to give the task to.
Example Response
<list id="987654321">
<taskseries id="987654321" created="2015-05-07T10:19:54Z" modified="2015-05-07T10:19:54Z"
name="Get Bananas" source="api">
<tags/>
<participants/>
<notes/>
<task id="123456789" due="" has_due_time="0" added="2015-05-07T10:19:54Z"
completed="" deleted="" priority="N" postponed="0" estimate=""/>
</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.
360 contact_id invalid or not provided
- No contact_id provided / contact_id invalid.
3040 List is read-only.
- Tried to perform action in read-only list.
4000 Task name provided is invalid.
- The task name provided is invalid.
4020 Cannot add task to a Smart List.
- Cannot add task to a Smart List.
4040 Sub-task only editable by Pro accounts
- Non-pro account tried to update sub-task.
4050 parent_task_id invalid
- The parent_id provided is invalid.
4060 Sub-task nested too deep
- Sub-tasks may only be nested up to 3 levels.
4070 Repeating task exists in hierarchy
- Repeating sub-tasks may not have repeating ancestors and vice versa.