ActionPlan

Represents the instance of an action plan, a set of tasks created from an action plan template. This object is available in API version 44.0 and later.

Supported Calls

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

Fields

Field Name Details
ActionPlanState
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description

The status of work being done for the action plan.

Possible values are:
  • Canceled
  • Complete
  • In Progress
  • Not Started
The default value is Not Started.
ActionPlanTemplateVersionId
Type
reference
Properties
Create, Filter, Group, Sort
Description

The ID of the version of the action plan template used to create this action plan. At creation, the referenced action plan template must be in the published state.

ActionPlanType
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort
Description

The action plan’s type.

Possible values are:
  • Industries
  • Sales—This value is available in API version 63.0 and later with the Sales Action Plans add-on license and the Sales Action Plans default permission set.
  • Service
IsLocked
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description

Indicates whether the action plan is locked or not.

IsUsingHolidayHours
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort
Description

Indicates whether task completion dates have been calculated by incrementing the task offset for each non-work day, excluding recurring holidays.

LastReferencedDate
Type
dateTime
Properties
Filter, Nllable, Sort
Description

The most recent date on which a user referenced this record.

LastViewedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description

The most recent date on which a user viewed this record.

MayEdit
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description

Indicates whether the action plan can be edited or not.

Name
Type
string
Properties
Create, Filter, Group, idLookup, Sort, Update
Description

The name of the action plan.

OwnerId
Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description

The ID of the user who owns this record.

StartDate
Type
date
Properties
Create, Default on create, Filter, Group, Sort
Description

The start date of the action plan.

TargetId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort
Description

The ID of the parent object record that relates to this action plan.

For API version 63.0 and later, supported parent objects are Account, AccountPlanObjective, Applicant, ApplicationForm, ApplicationFormProduct, Asset, BusinessLicense, BusinessMilestone, Campaign, Case, ChangeRequest, Claim, Contact, Contract, FinancialGoal, Incident, InsurancePolicy, InsurancePolicyCoverage, Lead, Opportunity, PersonLifeEvent, Problem, ResidentialLoanApplication, WorkOrder, and WorkOrderLineItem.

For API version 62.0 and later, supported parent objects are ApplicationFormEvaluation and VettingEvaluation.

For API version 48.0 and later, supported parent objects are Account, AssetsAndLiabilities, BusinessMilestone, Campaign, Card, Case, Claim, Contact, Contract, Financial Account, Financial Goal, Financial Holding, InsurancePolicy, InsurancePolicyCoverage, Lead, Opportunity, PersonLifeEvent, ResidentialLoanApplication, and Visit as well as custom objects with activities enabled.

For API version 47.0 and later, supported parent objects are Account, BusinessMilestone, Campaign, Case, Claim, Contact, Contract, InsurancePolicy, InsurancePolicyCoverage, Lead, Opportunity, PersonLifeEvent, and Visit as well as custom objects with activities enabled.

For API version 46.0 and later, supported parent objects are Account, Campaign, Case, Contact, Contract, Lead, and Opportunity as well as custom objects with activities enabled.

For API version 45.0 and earlier, the only supported parent object is Account.

Associated Objects

This object has the following associated objects. Unless noted, they are available in the same API version as this object.

ActionPlanChangeEvent
Change events are available for the object.
ActionPlanFeed
Feed tracking is available for the object.
ActionPlanHistory
History is available for tracked fields of the object.
ActionPlanOwnerSharingRule
Sharing rules are available for the object.
ActionPlanShare
Sharing is available for the object.