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.

Note
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.

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.
Note
This field can’t be set or updated for a recurring task (IsRecurrence is true).
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
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.
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, 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.
Note
This field can’t be updated for recurring tasks (IsRecurrence is true).
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.
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
ID of a related Account, Opportunity, Campaign, Case, or custom object. Label is Opportunity/Account 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
Indicates the ID of a related Contact or Lead. If the WhoId refers to a lead, then the WhatId field must be empty. Label is Contact/Lead ID. If Shared Activities is enabled, the value of this field is the ID of a related Lead or primary Contact.

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
© Copyright 2000–2014 salesforce.com, inc. All rights reserved.
Various trademarks held by their respective owners.