Action Plan Templates (GET, POST)
API to create and get Action Plan Template items. An Action Plan
Template has a default set of parameters required to create an Action Plan.
- Resource
-
/connect/action-plan/actionplantemplateversion/${actionPlantemplateId}
- Resource Example
-
https://yourInstance.salesforce.com/services/data/63.0/connect/action-plan/actionplantemplateversion/0PTS60000004C9DOAU?allowOverrides=true
- Available version
- 57.0
- Requires Chatter
- No
- HTTP methods
- GET, POST
- Response body for GET
- Action Plan Template Items
- Request parameters for POST
-
Parameter Name Type Description Required or Optional Available Version shouldAllowOverride Boolean Indicates whether the Action Plan to be created from the Action Plan Template overrides the default parameters of the template (true) or not (false). Optional 57.0 - Request body for POST
-
- JSON example
-
{ "targetId":”07rS60000004CAUIA2", “name”:”Goal Assignment Action Demo”, "excludedItems":{ "records":[ “0PJS60000004CA1OAM” ] }, "updateableItems":{ "tasks":{ "records":[ { "id":"BSHS60000004CA1OQA", "subject":"Onboarding Mandatory Training", "dueDate":"30-01-2022", "status":"Completed", "priority":"High", "comment":"Mandatory trainings for the new hires", "assignedTo":"0YwS60000004IByKAM" } ] } }, "adhocItems":{ "tasks":{ "records":[ { "subject":"Salesforce Platform Basics Training", "dueDate":"20-02-2023", "status":"In Progress", "priority":"Normal", "comment":"Learn the Salesforce Platform basics", "assignedTo":"0BsS60000004IByRAM", "isRequired":"False" } ] } } }
- Properties
-
Name Type Description Required or Optional Available Version adhocItems Action Plan Item Tasks Input Details of the action plan items to be created. Optional 57.0 excludedItems String[] IDs of the action plan items to be removed. Optional 57.0 name String Name of the action plan. Required 57.0 targetId String Target ID of the action plan. Required 57.0 updateableItems Action Plan Item Tasks Input Action plan items to be updated. Optional 57.0
- Response body for POST
- Action Plan Output