Task

Represents a business activity such as making a phone call or other to-do items. In the user interface, Task and Event records are collectively referred to as activities.

Task fields related to calls are exclusive to Salesforce CRM Call Center. Additionally, query(), delete(), and update() aren’t allowed with tasks related to more than one contact in API versions 23.0 and earlier.

Note

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Fields

Field	Field Type
AccountId	Type reference Properties Group, Sort, Filter, Nillable Description Represents the ID of the related Account. The AccountId is determined as follows. If the value of WhatId is any of the following objects, then Salesforce uses that object’s AccountId. Account Opportunity Contract Custom object that is a child of Account If the value of the WhatIdfield is any other object, and the value of the WhoId field is a Contact object, then Salesforce uses that contact’s AccountId. (If your organization uses Shared Activities, then Salesforce uses the AccountId of the primary contact.) Otherwise, Salesforce sets the value of the AccountId field to `null`. For information on IDs, see ID Field Type.
ActivityDate	Type date Properties Group, Sort, Create, Filter, Nillable, Update Description Represents the due date of the task. This field has a timestamp that is always set to midnight in the Coordinated Universal Time (UTC) time zone. The timestamp is not relevant; do not attempt to alter it in order to accommodate time zone differences. Label is Due Date. This field can’t be set or updated for a recurring task (IsRecurrence is `true`). Note
CallDisposition	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Represents the result of a given call, for example, “we'll call back,” or “call unsuccessful.” Limit is 255 characters. Not subject to field-level security, available for any user in an organization with Salesforce CRM Call Center.
CallDurationInSeconds	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Duration of the call in seconds. Not subject to field-level security, available for any user in an organization with Salesforce CRM Call Center.
CallObject	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Name of a call center. Limit is 255 characters. Not subject to field-level security, available for any user in an organization with Salesforce CRM Call Center.
CallType	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The type of call being answered: Inbound, Internal, or Outbound.
ConnectionReceivedId	Type reference Properties Filter, Nillable Description ID of the PartnerNetworkConnection that shared this record with your organization. This field is only available if you have enabled Salesforce to Salesforce.
ConnectionSentId	Type reference Properties Filter, Nillable Description ID of the PartnerNetworkConnection that you shared this record with. This field is only available if you have enabled Salesforce to Salesforce. Beginning with API version 15.0, the ConnectionSentId field is no longer supported. The ConnectionSentId field is still visible, but the value is null. You can use the new PartnerNetworkRecordConnection object to forward records to connections.
Description	Type textarea Properties Create, Nillable, Update Description Contains a text description of the task.
IsArchived	Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the event has been archived.
IsClosed	Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the task has been completed (`true`) or not (`false`). Is only set indirectly via the Status picklist. Label is Closed.
IsHighPriority	Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates a high-priority task. This field is derived from the Priority field.
IsRecurrence	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort Description Indicates whether the task is scheduled to repeat itself (`true`) or only occurs once (`false`). This is a read-only field on update, but not on create. If this field value is `true`, then RecurrenceStartDateOnly, RecurrenceEndDateOnly, RecurrenceType, and any recurrence fields associated with the given recurrence type must be populated. See Recurring Tasks.
IsReminderSet	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether a popup reminder has been set for the task (`true`) or not (`false`).
IsVisibleInSelfService	Type boolean Properties Defaulted on create, Filter, Update Description Indicates whether a task associated with an object can be viewed in the Customer Portal (`true`) or not (`false`). If your organization has enabled Communities, tasks marked IsVisibleInSelfService are visible to any external user in the community, as long as the user has access to the record the task was created on. This field is available when Customer Portal or partner portal are enabled OR Communities is enabled and you have Customer Portal or partner portal licenses.
OwnerId	Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the User who owns the record. Label is Assigned To ID.
Priority	Type picklist Properties Defaulted on create, Group, Sort, Create, Filter, Update Description Required. Indicates the importance or urgency of a task, such as high or low.
RecurrenceActivityId	Type reference Properties Filter, Group, Nillable, Sort Description Read-only. Not required on create. ID of the main record of the recurring task. Subsequent occurrences have the same value in this field.
RecurrenceDayOfMonth	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The day of the month in which the task repeats.
RecurrenceDayOfWeekMask	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The day or days of the week on which the task repeats. This field contains a bitmask. The values are as follows: Sunday = 1 Monday = 2 Tuesday = 4 Wednesday = 8 Thursday = 16 Friday = 32 Saturday = 64 Multiple days are represented as the sum of their numerical values. For example, Tuesday and Thursday = 4 + 16 = 20.
RecurrenceEndDateOnly	Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The last date on which the task repeats. This field has a timestamp that is always set to midnight in the Coordinated Universal Time (UTC) time zone. The timestamp is not relevant; do not attempt to alter it in order to accommodate time zone differences.
RecurrenceInstance	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The frequency of the recurring task. For example, “2nd” or “3rd.”
RecurrenceInterval	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The interval between recurring tasks.
RecurrenceMonthOfYear	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The month of the year in which the task repeats.
RecurrenceRegeneratedType	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Represents what triggers a repeating task to repeat. Add this field to a page layout together with the RecurrenceInterval field, which determines the number of days between the triggering date (due date or close date) and the due date of the next repeating task in the series. Label is Repeat This Task. This field has the following picklist values: None: The task doesn’t repeat. After due date: The next repeating task will be due the specified number of days after the current task’s due date. After the task is closed: The next repeating task will be due the specified number of days after the current task is closed. (Task closed): This task, now closed, was opened as part of a repeating series.
RecurrenceStartDateOnly	Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The date when the recurring task begins. Must be a date and time before RecurrenceEndDateOnly.
RecurrenceTimeZoneSidKey	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The time zone associated with the recurring task. For example, “UTC-8:00” for Pacific Standard Time.
RecurrenceType	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Indicates how often the task repeats. For example, daily, weekly, or every nth month (where “nth” is defined in RecurrenceInstance).
ReminderDateTime	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Represents the time when the reminder is scheduled to fire, if IsReminderSet is set to `true`. If IsReminderSet is set to `false`, then the user may have deselected the reminder checkbox in the Salesforce user interface, or the reminder has already fired at the time indicated by the value.
Status	Type picklist Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Required. The current status of the task, such as In Progress or Completed. Each predefined Status field implies a value for the IsClosed flag. To obtain picklist values, query the TaskStatus object. This field can’t be updated for recurring tasks (IsRecurrence is `true`). Note
Subject	Type combobox Properties Create, Filter, Nillable, Sort, Update Description The subject line of the task, such as “Call” or “Send Quote.” Limit: 255 characters.
TaskSubtype	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description Provides standard subtypes to facilitate creating and searching for specific task subtypes. This field isn’t updateable. TaskSubtype values: Task Email Call
TaskWhoIds	Type JunctionIdList Properties Create, Update Description A string array of contact or lead IDs related to this task. This JunctionIdList field is linked to the TaskWhoRelations child relationship. TaskWhoIds is only available when the shared activities setting is enabled. The first contact or lead ID in the list becomes the primary WhoId if you don’t specify a primary WhoId. Adding a JunctionIdList field name to the fieldsToNull property deletes all related junction records. This action can’t be undone. Warning
Type	Type picklist Properties Create, Filter, Nillable, Update Description The type of task, such as Call or Meeting.
WhatCount	Type int Properties Filter, Group, Nillable, Sort Description Available to organizations that have Shared Activities enabled. Count of related TaskRelations pertaining to WhatId. Count of the WhatId must be `1` or less.
WhatId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The WhatId represents nonhuman objects such as accounts, opportunities, campaigns, cases, or custom objects. WhatIds are polymorphic. Polymorphic means a WhatId is equivalent to the ID of a related object. The label is Related To ID.
WhoCount	Type int Properties Filter, Group, Nillable, Sort Description Available to organizations that have Shared Activities enabled. Count of related TaskRelations pertaining to WhoId.
WhoId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The WhoId represents a human such as a lead or a contact. WhoIds are polymorphic. Polymorphic means a WhoId is equivalent to a contact’s ID or a lead’s ID. The label is Name ID. If Shared Activities is enabled, the value of this field is the ID of the related lead or primary contact. If you add, update, or remove the WhoId field, you might encounter problems with triggers, workflows, and data validation rules that are associated with the record. The label is Name ID.

Usage

Recurring Tasks

Recurring tasks are available in API version 16.0 and later.
After a task is created, it can’t be changed from recurring to nonrecurring or vice versa.
When you delete a recurring task series through the API, all open and closed task occurrences in the series are removed. However, when you delete a recurring task series through the user interface, only open tasks occurrences (IsClosed is false) in the series are removed.
If IsRecurrence is true, then RecurrenceStartDateOnly, RecurrenceEndDateOnly, RecurrenceType, and any properties associated with the given recurrence type (see the following table) must be populated.
When you change the RecurrenceStartDateOnly field or the recurrence pattern, all open tasks occurrences in the series are deleted and new open task occurrences are created based on the new recurrence pattern. The recurrence pattern is determined by the following fields: RecurrenceType, RecurrenceTimeZoneSidKey, RecurrenceInterval, RecurrenceDayOfWeekMask, RecurrenceDayOfMonth, RecurrenceInstance, and RecurrenceMonthOfYear.
When you change the value of RecurrenceEndDateOnly to an earlier date (for example, from January 20th to January 10th), all open task occurrences in the series with the ActivityDate value greater than the new end date value are deleted. Other open and closed task occurrences in the series are not affected.
When you change the value of RecurrenceEndDateOnly to a later date (for example, from January 10th to January 20th), new task occurrences are created up to the new end date. Existing open and closed tasks in the series are not affected.

The following table describes the usage of recurrence fields. Each recurrence type must have all of its properties set. All unused properties must be set to null.

RecurrenceType Value	Properties	Example Pattern
RecursDaily	RecurrenceInterval	Every second day
RecursEveryWeekday	RecurrenceDayOfWeekMask	Every weekday - can’t be Saturday or Sunday
RecursMonthly	RecurrenceDayOfMonth RecurrenceInterval	Every second month, on the third day of the month
RecursMonthlyNth	RecurrenceInterval RecurrenceInstance RecurrenceDayOfWeekMask	Every second month, on the last Friday of the month
RecursWeekly	RecurrenceInterval RecurrenceDayOfWeekMask	Every three weeks on Wednesday and Friday
RecursYearly	RecurrenceDayOfMonth RecurrenceMonthOfYear	Every March on the twenty-sixth day of the month
RecursYearlyNth	RecurrenceDayOfWeekMask RecurrenceInstanceRecurrenceMonthOfYear	The first Saturday in every October

JunctionIdList

The JunctionIdList field is now implemented in the Event and Task objects. With a single API call, it’s easy to create many-to-many relationships between the Event or Task object with contacts, leads, or users.

To create a Task with related Contacts without JunctionIdList, you first have to create the task, then use the returned task ID to create the TaskRelation records. If the TaskRelation save call fails, error handling is your responsibility because the task has already been committed to the database.

1public void createTasksOld(Contact[] contacts) {
2	Task task = new Task();
3	task.setSubject("New Task");
4	SaveResult[] results = null;
5	try {
6		results = connection.create(new Task[] {
7			task
8		});
9		if (results[0].isSuccess()) {
10			TaskRelation[] relations = new TaskRelation[contacts.size()];
11			for (int i = 0; i < contacts.length; i++) {
12				relations[i] = new TaskRelation();
13				relations[i].setTaskId(results[0].getID());
14				resltsion[i].setRelationId(contacts[i].getID());
15			}
16			results = connection.create(relations);
17		}
18	} catch (ConnectionException ce) {
19		ce.printStackTrace();
20	}
21}

To create a task using JuncionIdList, IDs are pulled from the related contacts and both the task and the TaskRelation records are created in one API call. If the TaskRelation fails, the task is rolled back because it’s all done in a single API call.

1public void createTaskNew(Contact[] contacts) {
2	String[] contactIds = new String[contacts.size()];
3	for (int i = 0; i < contacts.size(); i++) {
4		contactIds[i] = contacts[i].getID();
5	}
6	Task task = new Task();
7	task.setSubject("New Task");
8	task.setTaskWhoIds(contactIds);
9	SaveResult[] results = null;
10	try {
11		results = connection.create(new Task[] {
12			task
13		});
14	} catch (ConnectionException ce) {
15		ce.printStackTrace();
16	}
17}

Object Reference for Salesforce and Force.com

Task

Supported Calls

Fields

Usage

See Also: