---
schema_version: "1"
id: e36d9f7e3273bae572580508dd1a9976f06a6eaecce6650f018f725b176262af
title: ActionPlanTemplate
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/meta_actionplantemplate.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_actionplantemplate.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 7985f7be774d3c4e431dff8beb1f3ebb2df6303dd99c31a938399ac1bca5380d
description: Represents the instance of an action plan template.
---
# ActionPlanTemplate

Represents the instance of an action plan template.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

ActionPlanTemplate components have the suffix .apt and are stored in the actionPlanTemplates folder.

## Version

Action Plan Template components are available in API version 47.0 and later.

## Special Access Rules

To create or access action plan templates, you must have the Customize Application permission and the IndustriesActionPlans license.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d76339e107">Field Name</th>

              <th class="featureTableHeader  " id="d76339e110">Field Type</th>

              <th class="featureTableHeader  " id="d76339e113">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d76339e107" data-title="Field Name"><span class="keyword parmname">actionPlanTemplateItem</span></td>

              <td class="entry" headers="d76339e110" data-title="Field Type"><a class="xref" href="#ActionPlanTemplateItem">ActionPlanTemplateItem</a></td>

              <td class="entry" headers="d76339e113" data-title="Description">The instance of an item on an action plan template version.</td>

            </tr>

            <tr>
              <td class="entry" headers="d76339e107" data-title="Field Name"><span class="keyword parmname">actionPlanTemplateItemDependencies</span></td>

              <td class="entry" headers="d76339e110" data-title="Field Type"><a class="xref" href="#ActionPlanTemplateItemDependency">ActionPlanTemplateItemDependency[]</a></td>

              <td class="entry" headers="d76339e113" data-title="Description">Defines the dependencies between action plan template items. Available in API
                version 59.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d76339e107" data-title="Field Name"><span class="keyword parmname">actionPlanType</span></td>

              <td class="entry" headers="d76339e110" data-title="Field Type">ActionPlanTemplateType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)</td>

              <td class="entry" headers="d76339e113" data-title="Description">Type of the action plan template. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Industries</samp></li>

                  <li class="li"><samp class="codeph nolang">Retail</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">ITSM</samp>—Available in API version 65.0
                    and later.
                  </li>

                  <li class="li"><samp class="codeph nolang">PrvdEngmtCompliance</samp></li>

                  <li class="li"><samp class="codeph nolang">KAM</samp></li>

                </ul>
                <p class="p">Available in API version 63.0 and later. </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d76339e107" data-title="Field Name"><span class="keyword parmname">category</span></td>

              <td class="entry" headers="d76339e110" data-title="Field Type">string</td>

              <td class="entry" headers="d76339e113" data-title="Description">Category for this action plan template. Available in API version 64.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d76339e107" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d76339e110" data-title="Field Type">string</td>

              <td class="entry" headers="d76339e113" data-title="Description">The description of the action plan template.</td>

            </tr>

            <tr>
              <td class="entry" headers="d76339e107" data-title="Field Name"><span class="keyword parmname">estimatedCompletionDays</span></td>

              <td class="entry" headers="d76339e110" data-title="Field Type">int</td>

              <td class="entry" headers="d76339e113" data-title="Description">Estimated number of days required to complete the action plan. Available in API
                version 64.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d76339e107" data-title="Field Name"><span class="keyword parmname">fileBasedTemplatePath</span></td>

              <td class="entry" headers="d76339e110" data-title="Field Type">string</td>

              <td class="entry" headers="d76339e113" data-title="Description">File path for a file-based action plan template. Available in API version 64.0
                and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d76339e107" data-title="Field Name"><span class="keyword parmname">isAdHocItemCreationEnabled</span></td>

              <td class="entry" headers="d76339e110" data-title="Field Type">boolean</td>

              <td class="entry" headers="d76339e113" data-title="Description">Required. Indicates whether ad hoc item creation is enabled for this action
                plan template (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 59.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d76339e107" data-title="Field Name"><span class="keyword parmname">name</span></td>

              <td class="entry" headers="d76339e110" data-title="Field Type">string</td>

              <td class="entry" headers="d76339e113" data-title="Description">Required. The name of the action plan template.</td>

            </tr>

            <tr>
              <td class="entry" headers="d76339e107" data-title="Field Name"><span class="keyword parmname">sourceType</span></td>

              <td class="entry" headers="d76339e110" data-title="Field Type">string</td>

              <td class="entry" headers="d76339e113" data-title="Description">Source type of the action plan template. Available in API version 64.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d76339e107" data-title="Field Name"><span class="keyword parmname">status</span></td>

              <td class="entry" headers="d76339e110" data-title="Field Type">string</td>

              <td class="entry" headers="d76339e113" data-title="Description">Status of the action plan template. Available in API version 64.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d76339e107" data-title="Field Name"><span class="keyword parmname">subcategory</span></td>

              <td class="entry" headers="d76339e110" data-title="Field Type">string</td>

              <td class="entry" headers="d76339e113" data-title="Description">Subcategory for this action plan template. Available in API version 64.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d76339e107" data-title="Field Name"><span class="keyword parmname">targetEntityType</span></td>

              <td class="entry" headers="d76339e110" data-title="Field Type">string</td>

              <td class="entry" headers="d76339e113" data-title="Description">Required. The parent object this action plan template relates to. Supported
                parent objects are Account, BusinessMilestone, Campaign, Case, Claim, Contact,
                Contract, InsurancePolicy, InsurancePolicyCoverage, Lead, Opportunity,
                PersonLifeEvent, and Visit and custom objects with activities enabled.</td>

            </tr>

            <tr>
              <td class="entry" headers="d76339e107" data-title="Field Name"><span class="keyword parmname">uniqueName</span></td>

              <td class="entry" headers="d76339e110" data-title="Field Type">string</td>

              <td class="entry" headers="d76339e113" data-title="Description">Required. The unique identifier for this action plan template record.</td>

            </tr>

          </tbody>

        </table>

## ActionPlanTemplateItem

Represents the instance of an item on an action plan template version.

| Field Name | Field Type | Description |
| --- | --- | --- |
| actionPlanTemplateItemValue | [ActionPlanTemplateItemValue](#ActionPlanTemplateItemValue) | The value associated with the action plan template item. |
| displayOrder | int | The order in which this item is displayed within the action plan template version. |
| isRequired | boolean | Indicates whether the task created from this template item is required. |
| itemEntityType | string | Required. The name of the field on the action plan template item that this value is for. Available in API version 48.0 and later. |
| name | string | Required. The name of the action plan template item. |
| uniqueName | string | Required. The unique identifier for this action plan template item record. |

## ActionPlanTemplateItemDependency

Represents a dependency between action plan template items, defining the sequential relationship and creation timing of items. Available in API version 59.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| creationType | string | Required. Defines how the dependent item is created in the action plan. |
| name | string | Required. Name of the dependency relationship. |
| previousTemplateItem | [ActionPlanTemplateItem](#ActionPlanTemplateItem) | Required. Reference to the prerequisite template item that must be completed before the dependent item begins. |
| templateItem | [ActionPlanTemplateItem](#ActionPlanTemplateItem) | Required. Reference to the dependent template item that relies on the completion of the previous item. |

## ActionPlanTemplateItemValue

Represents the value associated with an action plan template item.

| Field Name | Field Type | Description |
| --- | --- | --- |
| itemEntityType | string | Required. The name of the field on the action plan template item that this value is for. Available in API version 48.0 and later. |
| name | string | Required. The name of the action plan template item value. |
| valueFormula | string | The formula for this action plan template item. |
| valueLiteral | string | The value for this action plan template item. |

## Declarative Metadata Sample Definition

The following is an example of an ActionPlanTemplate component.

<?xml version="1.0" encoding="UTF-8"?>
<ActionPlanTemplate xmlns="http://soap.sforce.com/2006/04/metadata">
    <actionPlanTemplateItem\>
        <actionPlanTemplateItemValue\>
            <name\>Subject</name\>
            <valueLiteral\>APT 01 Account Packaging APTI 01</valueLiteral\>
            <itemEntityType\>Task</itemEntityType\>
        </actionPlanTemplateItemValue\>
        <actionPlanTemplateItemValue\>
            <name\>Priority</name\>
            <valueLiteral\>Normal</valueLiteral\>
            <itemEntityType\>Task</itemEntityType\>
        </actionPlanTemplateItemValue\>
        <actionPlanTemplateItemValue\>
            <name\>ActivityDate</name\>
            <valueFormula\>StartDate + 10</valueFormula\>
            <itemEntityType\>Task</itemEntityType\>
        </actionPlanTemplateItemValue\>
        <displayOrder\>1</displayOrder\>
        <isRequired\>true</isRequired\>
        <itemEntityType\>Task</itemEntityType\>
        <name\>APT 01 Account Packaging APTI 01</name\>
        <uniqueName\>APT\_01\_Account\_Packaging\_APTI\_01\_2827f387\_9dbc\_11e9\_920a\_e95716848ddd</uniqueName\>
    </actionPlanTemplateItem\>
    <actionPlanTemplateItem\>
        <actionPlanTemplateItemValue\>
            <name\>Subject</name\>
            <valueLiteral\>APT 01 Account Packaging APTI 02</valueLiteral\>
            <itemEntityType\>Task</itemEntityType\>
        </actionPlanTemplateItemValue\>
        <actionPlanTemplateItemValue\>
            <name\>Priority</name\>
            <valueLiteral\>Normal</valueLiteral\>
            <itemEntityType\>Task</itemEntityType\>
        </actionPlanTemplateItemValue\>
        <actionPlanTemplateItemValue\>
            <name\>ActivityDate</name\>
            <valueFormula\>StartDate + 10</valueFormula\>
            <itemEntityType\>Task</itemEntityType\>
        </actionPlanTemplateItemValue\>
        <displayOrder\>1</displayOrder\>
        <isRequired\>true</isRequired\>
        <itemEntityType\>Task</itemEntityType\>
        <name\>APT 01 Account Packaging APTI 02</name\>
        <uniqueName\>APT\_01\_Account\_Packaging\_APTI\_02\_3430da7b\_9dbc\_11e9\_920a\_b5d3292906c3</uniqueName\>
    </actionPlanTemplateItem\>
    <actionPlanTemplateItem\>
        <actionPlanTemplateItemValue\>
            <name\>Subject</name\>
            <valueLiteral\>APT 01 Account Packaging APTI 03</valueLiteral\>
            <itemEntityType\>Task</itemEntityType\>
        </actionPlanTemplateItemValue\>
        <actionPlanTemplateItemValue\>
            <name\>Priority</name\>
            <valueLiteral\>Normal</valueLiteral\>
            <itemEntityType\>Task</itemEntityType\>
        </actionPlanTemplateItemValue\>
        <actionPlanTemplateItemValue\>
            <name\>ActivityDate</name\>
            <valueFormula\>StartDate + 10</valueFormula\>
            <itemEntityType\>Task</itemEntityType\>
        </actionPlanTemplateItemValue\>
        <displayOrder\>1</displayOrder\>
        <isRequired\>true</isRequired\>
        <itemEntityType\>Task</itemEntityType\>
        <name\>APT 01 Account Packaging APTI 03</name\>
        <uniqueName\>APT\_01\_Account\_Packaging\_APTI\_03\_2d0363d9\_9dbc\_11e9\_920a\_219a003f176d</uniqueName\>
    </actionPlanTemplateItem\>
    <actionPlanTemplateItemDependencies\>
        <name\>APT Task Dependency</name\>
        <creationType\>OnPreviousItemCompleted</creationType\>
        <previousTemplateItem\>
            <actionPlanTemplateItemValue\>
                <name\>Subject</name\>
                    <valueLiteral\>APT 01 Account Packaging APTI 01</valueLiteral\>
                    <itemEntityType\>Task</itemEntityType\>
                </actionPlanTemplateItemValue\>
                <actionPlanTemplateItemValue\>
                    <name\>Priority</name\>
                    <valueLiteral\>Normal</valueLiteral\>
                    <itemEntityType\>Task</itemEntityType\>
                </actionPlanTemplateItemValue\>
                <actionPlanTemplateItemValue\>
                    <name\>ActivityDate</name\>
                    <valueFormula\>StartDate + 10</valueFormula\>
                    <itemEntityType\>Task</itemEntityType\>
            </actionPlanTemplateItemValue\>
            <displayOrder\>1</displayOrder\>
            <isRequired\>true</isRequired\>
            <itemEntityType\>Task</itemEntityType\>
            <name\>APT 01 Account Packaging APTI 01</name\>
            <uniqueName\>APT\_01\_Account\_Packaging\_APTI\_01\_2827f387\_9dbc\_11e9\_920a\_e95716848ddd</uniqueName\>
        </previousTemplateItem\>
        <templateItem\>
            <actionPlanTemplateItemValue\>
            <name\>Subject</name\>
            <valueLiteral\>APT 01 Account Packaging APTI 02</valueLiteral\>
            <itemEntityType\>Task</itemEntityType\>
            </actionPlanTemplateItemValue\>
            <actionPlanTemplateItemValue\>
                <name\>Priority</name\>
                <valueLiteral\>Normal</valueLiteral\>
                <itemEntityType\>Task</itemEntityType\>
            </actionPlanTemplateItemValue\>
            <actionPlanTemplateItemValue\>
                <name\>ActivityDate</name\>
                <valueFormula\>StartDate + 10</valueFormula\>
                <itemEntityType\>Task</itemEntityType\>
            </actionPlanTemplateItemValue\>
            <displayOrder\>1</displayOrder\>
            <isRequired\>true</isRequired\>
            <itemEntityType\>Task</itemEntityType\>
            <name\>APT 01 Account Packaging APTI 02</name\>
            <uniqueName\>APT\_01\_Account\_Packaging\_APTI\_02\_3430da7b\_9dbc\_11e9\_920a\_b5d3292906c3</uniqueName\>
        </templateItem\>
    </actionPlanTemplateItemDependencies\>
    <description\>APT 01 Account Packaging Description</description\>
    <name\>APT 01 Account Packaging</name\>
    <targetEntityType\>Account</targetEntityType\>
    <actionPlanType\>Industries</actionPlanType\>
    <uniqueName\>APT\_01\_Account\_Packaging\_0c9e8b15\_9dbc\_11e9\_920a\_8d6ecf990219</uniqueName\>
    <isAdHocItemCreationEnabled\>false</isAdHocItemCreationEnabled\>
    <category\>Onboarding</category\>
    <subcategory\>OnBoarding Product</subcategory\>
    <estimatedCompletionDays\>4</estimatedCompletionDays\>
    <sourceType\>Migrated From SandBox</sourceType\>
    <fileBasedTemplatePath\>Action Plan Template</fileBasedTemplatePath\>
    <status\>Draft</status\>
</ActionPlanTemplate\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>ActionPlanTemplate</name\>
    </types\>
    <version\>47.0</version\>
</Package\>

## Wildcard Support in the Manifest File

This metadata type supports the wildcard character \* (asterisk) in the package.xml manifest file. For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based.htm "HTML (New Window)").