ActionCPFT
Creates one or more Playbooks from a template, copying the child hierarchy of Tasks and Skills. Child records are populated asynchronously unless Is Asynchronous Process is set to false (recommended setting for agents).
| Property | Value |
|---|
| Label | Create Playbook from Template |
| Category | Success Management |
| Since | April 2023 |
| Read-only | No |
| Supports Agents | Yes |
| Supports Flows | Yes |
| Async Action | Yes |
| Keywords | — |
Request Parameters
| Field | Type | Label | Description | Required |
|---|
TemplatePlaybookId | Id | Template Playbook ID | The template playbook ID used as a template to create a new playbook. | Yes |
PlaybookName | String | Playbook Name | Name for the new Playbook. | Yes |
StartDate | Date | Start Date | The start date of the playbook. This is also used to calculate a date offset value for the start dates of the playbook's related records. | Yes |
IsActive | Boolean | Is Active | Indicates if the cloned playbook is active. | Yes |
IsTemplate | Boolean | Is Template | Indicates if the cloned playbook is a template. | Yes |
AccountId | Id | Account ID | The account ID. | No |
ObjectiveId | Id | Objective ID | The objective ID. | No |
TeamId | Id | Team ID | The team ID. | No |
PlaybookStatus | String | Playbook Status | The playbook status. | No |
PlaybookOwner | Id | Playbook Owner | The playbook owner. | No |
PlaybookStage | String | Playbook Stage | The playbook stage. | No |
PlaybookDescription | String | Playbook Description | The playbook description. | No |
ParentSuccessPlanId | String | Parent Success Plan | The ID of the parent success plan. | No |
EstimatedHours | Double | Estimated Hours | The estimated time in hours for this playbook. | No |
CopySkillsFromPlaybook | Boolean | Copy CS Skills From Playbook | When true, CS Skills are copied from the template Playbook to the new Playbook. | No |
IsAsynchronousProcess | Boolean | Is Asynchronous Process | When false, child records are created in the same transaction. Defaults to true (asynchronous). | No |
Response Parameters
| Field | Type | Label | Description | Required |
|---|
IsSuccess | Boolean | Is Success | True if the Playbook was successfully created. | No |
NewPlaybookId | Id | New Playbook ID | ID of the newly created Playbook. | No |
QueuedJobId | Id | Queued Job ID | The CreatePlaybookFromTemplateService may spawn a Queueable to complete the work in a later transaction. When that happens, this is the ID of the AsyncApexJob that controls work. The record can be queried to monitor its status. | No |
ErrorString | String | Error | Stores exception messages that occur when executing methods from CreatePlaybookFromTemplateService. | No |
| 