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. Also, 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 Filter, Group, Nillable, Sort 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. This is a relationship field. Relationship Name Account Relationship Type Lookup Refers To Account
ActivityDate	Type date Properties Create, Filter, Group, Nillable, Sort, 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 to accommodate time zone differences. Label is Due Date. 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. Possible values are: `Inbound` `Internal` `Outbound` When working with PushTopic, the CallType values display as `1` for `Inbound`, `0` for `Internal`, and `2` for `Outbound`.
CompletedDateTime	Type dateTime Properties Filter, Nillable, Sort Description The date and time the task was saved with a Closed status. For insert, if the task is saved with a Closed status the field is set. If the task is saved with an Open status the field is set to NULL. For update, if the task is saved with a new Closed status, the field is reset. If the task is saved with a new non-closed status, the field is reset to NULL. If the task is saved with the same closed status (that is, unchanged) there is no change to the field. The status is a dynamic enum. If the Closed mapping is changed it won’t cause an update of existing tasks. Only new insert/update operations are affected.
ConnectionReceivedId	Type reference Properties Filter, Group, Nillable, Sort Description ID of the PartnerNetworkConnection that shared this record with your organization. This field is available if you enabled Salesforce to Salesforce.
ConnectionSentId	Type reference Properties Filter, Group, Nillable, Sort Description ID of the PartnerNetworkConnection that you shared this record with. This field is available if you enabled Salesforce to Salesforce. This field is supported using API versions earlier than 15.0. In all other API versions, this field’s 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. The text provided in the Description field shows in the Comments field on the task record detail page.
IsArchived	Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the event has been archived. The default value of this field is `false`.
IsClosed	Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the task has been completed (`true`) or not (`false`). The default value of this field is `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. The default value of this field is `false`.
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`). The default value of this field is `false`. This field is read-only 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`). The default value of this field is `false`.
IsVisibleInSelfService	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, 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 digital experiences enabled, tasks marked IsVisibleInSelfService are visible to any external user in the Experience Cloud site, as long as the user has access to the record the task was created on.
OwnerId	Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the User or Group who owns the record. Label is Assigned To ID. This field accepts Groups of type Queue only. In the user interface, Group IDs correspond with the queue’s list view names. To create or update tasks assigned to Group, use v48.0 or later. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User
Priority	Type picklist Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Required. Indicates the importance or urgency of a task, such as high or low. The default value of this field is `Normal`.
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 to accommodate time zone differences.
RecurrenceInstance	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The frequency of the recurring task. Possible values are: `First`—1st `Fourth`—4th `Last`—last `Second`—2nd `Third`—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. When tasks in a series are set to repeat after their due date, Salesforce doesn’t create recurrences that would have been due in the past. Instead, Salesforce keeps adding the interval until a repeated task has a due date in the future. For example, suppose that someone sets a task to repeat three days after it’s due. But, that person doesn’t complete the task (mark it Closed) until five days after it’s due. Instead of creating a task that’s already overdue, Salesforce gives the new task a due date of tomorrow. This due date is equivalent to 6 days after the due date; two intervals of three days each. If that person completes the repeating task (marks it Closed) before the due date, the next task is still due three days after the due date.
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. Indicates the status of the task. The default value of this field is `Not Started`. Each predefined Status field implies a value for the IsClosed flag. To obtain picklist values, query the TaskStatus object. Possible values are: Completed Deferred In Progress Not Started Waiting on someone else 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.
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` `LinkedIn` —Available in API version 56.0 and later. `List Email` `Cadence` `Call` The `Cadence` subtype is an internal value used by Sales Engagement, and can’t be set manually.
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. If you set the EventWhoIds field to null, all entries in the list are deleted and the value of WhoId is added as the first entry. 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, Group, Nillable, Sort, 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. This is a polymorphic relationship field. Relationship Name What Relationship Type Lookup Refers To Account, Accreditation, AssessmentIndicatorDefinition, AssessmentTask, AssessmentTaskContentDocument, AssessmentTaskDefinition, AssessmentTaskOrder, Asset, AssetRelationship, AssignedResource, Award, BoardCertification, BusinessLicense, BusinessMilestone, BusinessProfile, Campaign, CareBarrier, CareBarrierDeterminant, CareBarrierType, CareDeterminant, CareDeterminantType, CareDiagnosis, CareInterventionType, CareMetricTarget, CareObservation, CareObservationComponent, CarePgmProvHealthcareProvider, CarePreauth, CarePreauthItem, CareProgram, CareProgramCampaign, CareProgramEligibilityRule, CareProgramEnrollee, CareProgramEnrolleeProduct, CareProgramEnrollmentCard, CareProgramGoal, CareProgramProduct, CareProgramProvider, CareProgramTeamMember, CareProviderAdverseAction, CareProviderFacilitySpecialty, CareProviderSearchableField, CareRegisteredDevice, CareRequest, CareRequestDrug, CareRequestExtension, CareRequestItem, CareSpecialty, CareSpecialtyTaxonomy, CareTaxonomy, Case, CommSubscriptionConsent, ContactEncounter, ContactEncounterParticipant, ContactRequest, Contract, CoverageBenefit, CoverageBenefitItem, CreditMemo, DelegatedAccount, DocumentChecklistItem, EnrollmentEligibilityCriteria, HealthcareFacility, HealthcareFacilityNetwork, HealthcarePayerNetwork, HealthcarePractitionerFacility, HealthcareProvider, HealthcareProviderNpi, HealthcareProviderSpecialty, HealthcareProviderTaxonomy, IdentityDocument, Image, IndividualApplication, Invoice, ListEmail, Location, MemberPlan, Opportunity, Order, OtherComponentTask, PartyConsent, PersonLifeEvent, PlanBenefit, PlanBenefitItem, ProcessException, Product2, ProductItem, ProductRequest, ProductRequestLineItem, ProductTransfer, PurchaserPlan, ReceivedDocument, ResourceAbsence, ReturnOrder, ReturnOrderLineItem, ServiceAppointment, ServiceResource, Shift, Shipment, ShipmentItem, Solution, Visit, VisitedParty, VolunteerProject, WorkOrder, WorkOrderLineItem
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. Beginning in API version 37.0, if the contact or lead ID in the WhoId field is not in the TaskWhoIds list, no error occurs and the ID is added to the TaskWhoIds as the primary WhoId. If WhoId is set to null, an arbitrary ID from the existing TaskWhoIds list is promoted to the primary position. This is a polymorphic relationship field. Relationship Name Who Relationship Type Lookup Refers To Contact, Lead

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 a user creates a series of recurring tasks, Salesforce creates a main record and subsequent occurrences. For the main record, IsRecurrence is set to true and other fields that define the recurrence pattern are populated. The ID of the main record of the recurring task is saved in the subsequent occurrences, in the RecurrenceActivityId field.
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 following fields determine the recurrence pattern: RecurrenceType, RecurrenceTimeZoneSidKey, RecurrenceInterval, RecurrenceDayOfWeekMask, RecurrenceDayOfMonth, RecurrenceInstance, and RecurrenceMonthOfYear.
When you change the value of RecurrenceEndDateOnly to an earlier date (for example, from January 20 to January 10), 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 10 to January 20), new task occurrences are created up to the new end date. Existing open and closed tasks in the series are not affected.

This table describes the usage of recurrence fields for Salesforce Classic recurring events. 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 26th 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				relations[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}

Shared Field-Level Security for Event and Task Objects

Metadata deployments for the Task object should always include the field-level security for the Event object. Shared field-level security prevents each object from changing the field-level security of the associated object.

Metadata deployments that include field-level security for only one of either the Event or Task objects can cause field-level security changes to the other object that aren't reflected in the metadata.

If field-level security is enabled for one object, then field-level security is enabled for both objects.
If field-level security is disabled for one object, then it's disabled for both objects.

A missing entry in the metadata is treated as field-level security being disabled.

Note

Associated Objects

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.

TaskChangeEvent (API version 44.0): Change events are available for the object.
TaskFeed (API version 20.0): Feed tracking is available for the object.

Object Reference for the Salesforce Platform

Task

Supported Calls

Fields

Usage

Associated Objects

See Also