Tasks remind you what you need to take care of each day. Each task is assigned to a user, and they'll show up in that user's daily agenda email and Workspace task list. Tasks stay on the task list until they're complete, so they won't slip through the cracks if you don't have time to deal with them on the day they're due.
If you're trying to schedule something at a specific time (e.g. a meeting, phone call, etc.) you should use an event, not a task. Tasks don't have time information (just dates).
Tasks are often attached to contacts, but they don't have to be, so you can use this is a general-purpose task list even for things unrelated to the contacts in your CRM.
This function creates a new task which will show up on the task list once it's due. It can be attached to a contact, but it doesn't have to be.
The name of the task. This is what will show up on the task list.
The date a task should start appearing on the Workspace and in the daily agenda email. It will stay in the task list until it is marked as complete.
Which user this task is assigned to. If you don't pass this value, it will be assigned to you by default.
Which calendar this task will be categorized under. We will add the task to your default calendar if you don't set a value.
Additional details you want to remember about the task that don't fit in the task name. This is displayed as a multi-line text fields, so newline characters will be honored.
The Id for the contact or company you want to attach this task to. If you don't pass this, the task won't be attached to a contact record.
This function edits an existing task, including marking it as completed or incomplete.
The Id of the task you want to edit.
The name of the task. This is what will show up on the task list.
The date a task should start appearing on the Workspace and in the daily agenda email. It will stay in the task list until it is marked as complete.
Which user this task is assigned to.
Which calendar this task will be categorized under.
Additional details you want to remember about the task that don't fit in the task name. This is displayed as a multi-line text fields, so newline characters will be honored.
The Id for the contact or company you want to attach this task to. Pass null
if the task is currently
attached to a contact and you'd like to detach it.
Mark the task as complete (true
) or incomplete (false
).
This function deletes a task. NOTE: This is not what you should call if you want to mark a task as completed. For that,
you should use the EditTask
function.
The Id of the task you want to delete.
This function retrieves a single task based on the Id of the task. If you don't already know the TaskId
you can
find tasks using GetTasks
or GetTasksAttachedToContact
.
The Id of the task you want to get.
This function will get all tasks between a date range; will return all visible tasks by default, but can be filtered by contact or user.
The lower bound of dates to fetch.
The upper bound of dates to fetch.
If you'd like to only see tasks assigned to specific users, pass their UserIds into this field and we'll filter the results to only show those users' tasks.
If you specify this parameter, all past and future tasks will be returned for the corresponding Contact regardless of CompletionStatus. Only tasks attached to this contact will be returned. Alternatively,
you can call GetTasksAttachedToContact
to get the same results.
Both
, Incomplete
, Complete
Get tasks based on task complete status
Ascending
, Descending
Whether the results should be sorted in ascending or descending order.
How many results should be returned from a single API call? The max value is 10,000. If you need to return
more results, call this API function again, but increment the Page
parameter.
If there are more results than MaxNumberOfResults
, you can call this function again with an incremented
Page
value to get the next page of results. For example, if there are 700 results, but you're only requesting
500 at a time, you could call this function with Page=2 to get the remaining 200 results.
Returns all tasks for a contact.
The contact to get tasks for.
How many results should be returned from a single API call? The max value is 10,000. If you need to return
more results, call this API function again, but increment the Page
parameter.
If there are more results than MaxNumberOfResults
, you can call this function again with an incremented
Page
value to get the next page of results. For example, if there are 700 results, but you're only requesting
500 at a time, you could call this function with Page=2 to get the remaining 200 results.